Welcome! We are excited that you are going down the path of creating more wonderful documentation in the world. This guide exists to provide both novice and expert writers a best practice handbook for building, structuring, and writing software documentation.
There are a number of topics that aren’t written yet. That means that you can write them! Please submit your thoughts and ideas, and you can contribute to making this guide better.
Now, let’s get started.
Getting Started with Documentation¶
Writing Great Documentation¶
- Structuring your Documentation
- Style Guides
- Interesting approaches to documentation
Documentation Culture at your Company¶
- Integrating Tech Writers into the product process
- Producing documentation inside a Support team
It’s always good to see the amazing things other folks have done. This gets us fired up. Check out these resources that we get inspired by:
- Your link here
Tools of the Trade¶
Keeping your documentation up to date
- Automated testing
- Link checking
- Code Testing
Common Output formats
- Documentation Styles
- Read the Docs Theme
- Text Editors
- Live Previews