Clik here to view.
Docs? Ask The Sphinx
If you need to generate docs for your Python projects, try Sphinx.
View ArticleClik here to view.
Why Good Developers Don’t Document
I don’t document because I know what I’m doing. Seriously. I sit down in front of the computer and beautiful code flows out of my fingertips. No idea how I do it. It’s like digesting for me. It just...
View ArticleClik here to view.
Useful documentation
Documentation is one of the last unconquered areas in software development. The tools tend to get better but the documentation … well, let’s say it could be better. Why? Part of the problem is that the...
View ArticleClik here to view.
Thoughts on documentation
Software developers believe that documentation is just another way to say code is buggy. The reasoning is like this: If the code was easy to understand and/or did what you expected, then why document...
View ArticleClik here to view.
New Approach to Documentation
Documentation usually has these three attributes: It’s incomplete, outdated and plain wrong. That doesn’t apply to every bit of information in your documentation but it you can be sure the statement...
View ArticleClik here to view.
If You Want Them to RTFM, Make a Better FM
If you’re interested in the conflicts between software and documentation, Alex Lagarde wrote a great post about that: Intent Discovery – Part 1 : the intents behind softwares. It explains what the...
View ArticleClik here to view.
TNBT: Documentation Sucks
Documentation is the unloved step-mother of software development: Nobody likes it. On the writing side, documentation is either considered a waste of time: I could write code in that time It won’t be...
View Article