[Axiom-developer] PLOS Rules for documenting scientific software

[Tim Daly]

https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1006561

1) Write comments as you code
2) Include examples and lots of them
3) Include a quickstart guide
4) Include a README file with basic information
5) Include a help command for command line interfaces
6) Version control your documentation
7) Fully document your application program interface
8) Use automated documentation tools
9) Write error messages that provide solutions or point to the documentation
10) Tell people how to cite your software