Documentation is part of what makes any resource awesome. Here are some tips to make awesome documentation!
- Follow a Readme Driven Development, thath means first writting a good README file and then start working on what's written.
- Write examples before definitions.
- Mark documents (Papers, Discourse) as deprecated adding
[DEPRECATED]to the title if you notice they're now longer accurate. - Document conventions as soon as you notice a fragmentation signal. Aim to keep as much consistency as you can (variable naming, default values, column types).