TLDR Web Dev · MISCELLANEOUS
HOW TO WRITE TECHNICAL DOCUMENTATION THAT PEOPLE WILL ACTUALLY READ AND USE
Summary from the TLDR Web Dev newsletter
Good documentation is clear, reproducible, and doesn't assume the reader's knowledge level. Documenting as you go along, rather than waiting until the end, is recommended because it allows for capturing details and maintaining clarity. Documentation should be modular so that parts can be expanded or skipped as needed. It should be reviewed by peers and ideally by potential users to ensure its comprehensiveness and usability.