info/the-documentation-compendium
1
0
Fork 0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-03 01:52:42 +02:00
Code Issues Releases Wiki Activity

Merge pull request #1 from Mandelliant/TABLE_OF_CONTENTS_UPDATE

Browse Source 
adds Art of Technical Writing section to table of contents
This commit is contained in:
Anthony
2019-10-23 12:44:26 -04:00
committed by GitHub
parent a9ba074559 f3f621e203
commit cd9b392857
1 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -26,7 +26,7 @@
- [Why must you document your project](#why_document)
- [Best Practices](#best_practices)
- [Templates](#templates)
- The Art of Technical Writing
- [The Art of Technical Writing](#art)
- [Novice Technical Writers](https://www.writethedocs.org/guide/#new-to-caring-about-documentation)
- [Experienced Technical Writers](https://www.writethedocs.org/guide/#experienced-documentarian)
- [API Documentation](https://www.writethedocs.org/guide/#api-documentation)
@@ -69,6 +69,15 @@ Even if for some reason they have to use it, without good documentation, they wo
- Don't clutter explanations with overly detailed examples
- Don't use terms that are offensive to any group. There will never be a good reason to
## The Art of Technical Writing <a name = "art"></a>
Further reading on technical writing topics from [www.writethedocs.org](https://www.writethedocs.org)
- [Novice Technical Writers](https://www.writethedocs.org/guide/#new-to-caring-about-documentation)
- [Experienced Technical Writers](https://www.writethedocs.org/guide/#experienced-documentarian)
- [API Documentation](https://www.writethedocs.org/guide/#api-documentation)
- [Adding badges](https://github.com/badges/shields/blob/master/README.md#examples)
- [Tools](https://www.writethedocs.org/guide/#tools-of-the-trade)
## Templates <a name = "templates"></a>