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 #33 from Mandelliant/master

Browse Source 
Adds "Art of Technical Writing" section to table of contents
This commit is contained in:
Kyle Lobo
2020-09-06 23:31:43 +05:30
committed by GitHub
parent 5888f29ed3 5682012fb7
commit c55d459ba2
1 changed files with 15 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -26,7 +26,7 @@
- [Why must you document your project](#why_document) - [Why must you document your project](#why_document)
- [Best Practices](#best_practices) - [Best Practices](#best_practices)
- [Templates](#templates) - [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) - [Novice Technical Writers](https://www.writethedocs.org/guide/#new-to-caring-about-documentation)
- [Experienced Technical Writers](https://www.writethedocs.org/guide/#experienced-documentarian) - [Experienced Technical Writers](https://www.writethedocs.org/guide/#experienced-documentarian)
- [API Documentation](https://www.writethedocs.org/guide/#api-documentation) - [API Documentation](https://www.writethedocs.org/guide/#api-documentation)
@@ -83,6 +83,17 @@ Even if for some reason they have to use it, without good documentation, they wo
- [TODO](/en/TODO.md) - [TODO](/en/TODO.md)
## 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)
## Technical Writing Programs <a name = "programs"></a> ## Technical Writing Programs <a name = "programs"></a>
1. [Google Season of Docs](https://developers.google.com/season-of-docs/) 1. [Google Season of Docs](https://developers.google.com/season-of-docs/)