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
• Writing READMEs
• Google Developer Documentation Style Guide

Perspectives

• “Just”

Writing Technical Tutorials & Posts

• How to do technical blogging
• Carbon

Documentation Tools

• Gitbook
• retext-assuming
• Alex

JavaScript

• Docco
• sphinx-js
• JSDoc

API

• Slate
• Stoplight

Python

• Sphinx