4th August 2022
Your documentation is complete when someone can use your module without ever having to look at its code. This is very important. This makes it possible for you to separate your module's documented interface from its internal implementation (guts). This is good because it means that you are free to change the module's internals as long as the interface remains the same.
Remember: the documentation, not the code, defines what a module does.
Recent articles
- Claude's new system prompt really doesn't want to reproduce song lyrics - 2nd September 2026
- Claude Fable 5.1 made me a really nice animated pelican - 1st September 2026
- Understanding ChatGPT Work - 30th August 2026