From f3f621e2034a17925ca37c5fb418b7d64d9581a1 Mon Sep 17 00:00:00 2001 From: Anthony Mandelli Date: Wed, 23 Oct 2019 12:41:29 -0400 Subject: [PATCH 1/2] adds Art of Technical Writing section to table of contents --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f12de20..37a2846 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,13 @@

The Documentation Compendium

- + [![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/) - +
@@ -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 + +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 @@ -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 From 5682012fb767b0be0dd2bcdd199995604c0f54d4 Mon Sep 17 00:00:00 2001 From: Kyle Lobo Date: Sun, 6 Sep 2020 23:31:29 +0530 Subject: [PATCH 2/2] Update README.md --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 37a2846..a3bfb9b 100644 --- a/README.md +++ b/README.md @@ -69,15 +69,6 @@ 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 - -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 @@ -92,6 +83,17 @@ Further reading on technical writing topics from [www.writethedocs.org](https:// - [TODO](/en/TODO.md) +## The Art of Technical Writing + +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 1. [Google Season of Docs](https://developers.google.com/season-of-docs/)