info/the-documentation-compendium
1
0
Fork 0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-10-04 08:21:39 +02:00
Code Issues Releases Wiki Activity

Added templates subsection, formated table of contents

Browse Source
This commit is contained in:
Kyle Lobo
2019-06-06 04:58:27 +05:30
committed by GitHub
parent 48846acd7c
commit fd5ee1b590
1 changed files with 31 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@@ -1,25 +1,33 @@
<div align = "center"> <p align="center">
<a href="" rel="noopener">
<img src="https://i.imgur.com/rSyq3MW.png" alt="The Documentation Compendium"></a>
</p>
![Documentation](https://i.imgur.com/rSyq3MW.png) <h3 align="center">The Documentation Compendium</h3>
<h3 align="center">The Documentation Compendium</h3> <div align="center">
<p align = "center">💡 Various templates & tips on writing high-quality documentation that people want to read.</p> [![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-MIT-blue.svg)](/LICENSE)
</div> </div>
--- ---
<p align = "center">💡 Various templates & tips on writing high-quality documentation that people want to read.</p>
## 📝 Table of Contents ## 📝 Table of Contents
+ [Why must you document your project](#why_document) + [Why must you document your project](#why_document)
+ [The DO's and DON'Ts of Documentation](#dos_and_donts) + [The DO's and DON'Ts of Documentation](#dos_and_donts)
+ [Templates](https://github.com/kylelobo/The-Documentation-Compendium/tree/master/Templates) + [Templates](#templates)
+ [Novice Technical Writers](https://www.writethedocs.org/guide/#new-to-caring-about-documentation) + The Art of Technical Writing
+ [Experienced Technical Writers](https://www.writethedocs.org/guide/#experienced-documentarian) + [Novice Technical Writers](https://www.writethedocs.org/guide/#new-to-caring-about-documentation)
+ [API Documentation](https://www.writethedocs.org/guide/#api-documentation) + [Experienced Technical Writers](https://www.writethedocs.org/guide/#experienced-documentarian)
+ [Adding badges](https://github.com/badges/shields/blob/master/README.md#examples) + [API Documentation](https://www.writethedocs.org/guide/#api-documentation)
+ [Tools](https://www.writethedocs.org/guide/#tools-of-the-trade) + [Adding badges](https://github.com/badges/shields/blob/master/README.md#examples)
+ [Tools](https://www.writethedocs.org/guide/#tools-of-the-trade)
+ [Technical Writer Programs](#programs) + [Technical Writer Programs](#programs)
+ [Awesome Technical Writing Sources](#sources) + [Awesome Technical Writing Sources](#sources)
+ [Get Feedback](#feedback) + [Get Feedback](#feedback)
@@ -50,6 +58,15 @@ Even if for some reason they have to use it because they have no choice, without
+ Don't clutter explanations with overly detailed examples + 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 + Don't use terms that are _offensive_ to any group. There will never be a good reason to
## 📜 Templates <a name = "templates"></a>
+ [README](/README%20Templates)
+ [Pull Request](/PULL_REQUEST_TEMPLATE.md)
+ [Issues](/.github/ISSUE_TEMPLATE)
+ [Contributing](/CONTRIBUTING.md)
+ [Code of Conduct](/CODE_OF_CONDUCT.md)
+ [Coding Guidelines](/CODING_GUIDELINES.md)
+ [Codebase Structure](/CODEBASE_STRUCTURE.md)
## 👨‍💻 Technical Writing Programs <a name = "programs"></a> ## 👨‍💻 Technical Writing Programs <a name = "programs"></a>
1. [A List of Open Source Projects with Volunteer Documentation Opportunities](https://www.reddit.com/r/technicalwriting/comments/800a9a/a_list_of_open_source_projects_with_volunteer/) 1. [A List of Open Source Projects with Volunteer Documentation Opportunities](https://www.reddit.com/r/technicalwriting/comments/800a9a/a_list_of_open_source_projects_with_volunteer/)