How to write good documentation
Following up from the discussion during our call on Nov 24, below is a preliminary list of links to guides and/or examples of how to write good documentation (in no particular order).
I would suggest that if you have a look at any of these to add a short comment on whether a particular link is useful and why. (To get an idea of which ones are most relevant.) Feel free to add more links!
- 5 examples of good code documentation and why
- guide from Berkeley
- guide with examples
- beginner's guide
- general resource on open research: preprint