awesome-writing
An awesome list of information to help developers writing better, kinder, more helpful documentation and learning materials
"If you propose to speak, always ask yourself, is it true, is it necessary, is it kind?"
Guides
- Humanizing Your Documentation
- Prose for Programmers
- Google Developer Documentation Style Guide
- The Best API Documentation
- Writing great documentation
- The Four Layers to Great Documentation
- 3 Essential Components of Great Documentation
- How I do Developer UX at Google
- Documenting Architecture Decisions
- Writing Documentation When You Aren’t A Technical Writer Series
- What's the best way to document JavaScript?
- How to remove condescending language from documentation
Readmes
Writing Technical Tutorials & Posts
- How to do technical blogging
- Carbon
- Five tips for improving your technical writing and documentation
- Tips for Improving Your Technical Writing Skills
- 7 Pieces of Information to Include in Technical Blog Posts
- Notes on Technical Writing
- Enable Learning in Technical Writing
Perspectives
- “Just”
- Write the Docs Podcast
- Mr. Rogers Had a Simple Set of Rules for Talking to Children
- Lowering the barriers
- Lessons Learned in a Year of Docs-Driven Development
- Tales from documentation: Write for your clueless users
- The TTS Handbook: A 21st-century approach to internal documentation
Other Resources
Documentation Tools
- Gitbook
- mdBook
- retext-assuming
- Alex
- Builder Book
- um - Command line utility for custom man-pages
- DocToc - markdown TOC generation
- Docusaurus