diff --git a/README.md b/README.md index 0eb5df8..a4beec3 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,33 @@ -
💡 Various templates & tips on writing high-quality documentation that people want to read.
+
+
+
+
💡 Various templates & tips on writing high-quality documentation that people want to read.
+ ## 📝 Table of Contents + [Why must you document your project](#why_document) + [The DO's and DON'Ts of Documentation](#dos_and_donts) -+ [Templates](https://github.com/kylelobo/The-Documentation-Compendium/tree/master/Templates) -+ [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](#templates) ++ The Art of Technical Writing + + [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 Writer Programs](#programs) + [Awesome Technical Writing Sources](#sources) + [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 use terms that are _offensive_ to any group. There will never be a good reason to +## 📜 Templates ++ [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 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/)