If your code will be seen by the world at large, one of your first tasks should be to write documentation. Document all functions as soon as you write them (before is also helpful). Provide samples on how to use code as soon as you finish a module (or earlier, if possible). Do not wait until your 5.0 release. Do not wait until your 1.0 release. Do not even wait until your 0.5 release. Do it as you write your code. The sooner, the better.
Users of your code will thank you profusely if you manage to provide comprehensive documentation along with the actual binaries of reference builds. DO NOT make them have to scour source code or bug developers in IRC channels to figure out a simple task like "get all cards from an address book" or "how do I write a synchronization conduit?"
3 comments:
Did you ever know that you're my hero?
Eric Shepherd
Developer Documentation Lead
Mozilla Corp.
Thanks for this and i loved this,
filmplus apk
For programmers releasing open-source code, prioritize documentation from the start. Write as you code—document functions, add usage samples after modules, and don’t delay until major releases. Clear documentation spares users from unnecessary effort, much like the ease of solving wordle unlimited daily.
Post a Comment