Writing Good Documentation for Developers
Documentation is the user interface for developers and developer tools.
Types of documentation
- Tutorials - step by step guide (studying)
- Explanations - why (theoretical knowledge)
- How to guides - real world tasks (working)
- Reference
more details here
Reference should be pslit into:
- Reference Docs
- API docs - describe code
Your user in on a journey that will take them to different areas of documentation.
Documentaion is content marketing.
Questions are bug reports.
Answers are patches.