3 ms·
Yes, I am going through this right now as a new hire onboarding to a boutique codebase. As soon as you are 100% reliant on internal docs, you realize just how l
by extr 3y ago
Yes, I am going through this right now as a new hire onboarding to a boutique codebase. As soon as you are 100% reliant on internal docs, you realize just how large the gap is between them and mainstream OSS libraries.
I think a decent middle-ground between "Document everything" and "Organically relay all information" is to just write "doc-stubs". Just a list of everything out there with no real content. It gives people a jumping off point to ask questions and lets them know what they don't know.
- throwaway173738 3y agoI’m also a big fan of having new people document things they wish they had known starting out.