info/the-documentation-compendium
1
0
Fork 0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-02 17:42:57 +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

17
README.md
View File

@@ -5,13 +5,13 @@
<h3 align="center">The Documentation Compendium</h3>
<div align="center">
[![Tweet](https://img.shields.io/twitter/url/https/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=%F0%9F%93%A2%20Various%20README%20templates%20and%20tips%20on%20writing%20high-quality%20documentation%20that%20people%20want%20to%20read.&url=https://github.com/kylelobo/The-Documentation-Compendium)
[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
[![License](https://img.shields.io/badge/license-CC0-blue.svg)](http://creativecommons.org/publicdomain/zero/1.0/)
<!-- <a href="https://www.producthunt.com/posts/the-documentation-compendium?utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-the-documentation-compendium" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=157965&theme=dark&period=daily" alt="The Documentation Compendium - Beautiful README templates that people want to read. | Product Hunt Embed" style="width: 250px; height: 54px;" width="250px" height="54px" /></a> -->
</div>
@@ -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>
@@ -81,7 +90,7 @@ Even if for some reason they have to use it, without good documentation, they wo
- [Codebase Structure](/en/CODEBASE_STRUCTURE.md)
- [Changelog](/en/CHANGELOG.md)
- [TODO](/en/TODO.md)
## Technical Writing Programs <a name = "programs"></a>