Writing a Best Practices Guide
summary
Starts as notes on Dr Gen configuration and evolves into a maintained Confluence best practices guide that collects recommendations, templates and examples. Documents include templates for six languages, setup tips for Sphinx GitLab and MS online help and ready answers reused in replies to developer questions. Claims a year of iteration produced a usable internal reference that teams adopt and that spawns separate best-practice docs in UX and other groups.
AI-written summary · about
related talks
18mTechnical Documentation - How Can I Write Them Better and Why Should I Care?
01h 24mWriting Documentation - Practices and Theory
40mDocumentation as User Experience
50mOpen Source Survival Guide
46mSave a Dev, Write Documentation!
37mTaking a step back: Analysing your documentation
13mTechnical documentation – how can I write them better and why should I care?
46mThe 7 Deadly Sins of Documentation