2 ms·
This is nonsense. Writing elaborate documentation is useless if you already understand your own concepts. Software docs are one thing (comments and readmes) but
by junon 5y ago
This is nonsense. Writing elaborate documentation is useless if you already understand your own concepts. Software docs are one thing (comments and readmes) but elaborate documentation meant for knowledge sharing that is never actually read is just a waste of time.
Your sentiment feels more like "dig a hole, it builds character!"
- popinman322 5y agoWhat is "elaborate" here? I write out personal work docs in a wiki complete with links for cross reference and a semantic search engine. Is that elaborate? I like that I often only need to ask a question once, and that I can delegate answering questions to the docs (where I've published subsections for the rest of the team). Moreover, as someone with a bachelor's degree in Cognitive Science & Computer Science, I know from the literature and experience that writing things down improves your memory. If I'm doing it to save my time and expand my memory, then it doesn't matter who else might read it.
- marrs 5y agoHas this been your experience with writing documentation or are you just saying this because it’s obvious. I only ask because, first and foremost, documentation is for you.
- junon 5y agoNo. Documentation is for the code or the project, for any reader. Proper documentation can be read and understood by anyone that needs to interact with the project. I don't know when it was decided that "documentation is for yourself" but I very much disagree.
- regularjack 5y agoDocumentation is for yourself in 2 years.