mirror of
https://github.com/kylelobo/The-Documentation-Compendium.git
synced 2025-09-03 10:02:41 +02:00
Removed italics, changed few emojis, renamed DOs & DONTs
This commit is contained in:
40
README.md
40
README.md
@@ -20,7 +20,7 @@
|
||||
|
||||
## 📝 Table of Contents
|
||||
+ [Why must you document your project](#why_document)
|
||||
+ [The DO's and DON'Ts of Documentation](#dos_and_donts)
|
||||
+ [Best Practices](#best_practices)
|
||||
+ [Templates](#templates)
|
||||
+ The Art of Technical Writing
|
||||
+ [Novice Technical Writers](https://www.writethedocs.org/guide/#new-to-caring-about-documentation)
|
||||
@@ -34,29 +34,29 @@
|
||||
+ [Acknowledgements](#acknowledgements)
|
||||
|
||||
## 🤔 Why must you document your project? <a name = "why_document"></a>
|
||||
+ It doesn’t matter how _good_ your software is, because if the documentation is not good enough, people will not use it.
|
||||
Even if for some reason they have to use it because they have no choice, without good documentation, they won’t use it _effectively_ or the way you’d like them to
|
||||
+ THE MAJORITY OF PEOPLE GLANCE AND LEAVE. Make it pretty so that it's easier for them to _star_ before they leave. The more stars you have, the likelier it is that serious developers will use your repo
|
||||
+ You will be using your code in _6 months_. Code that you wrote 6 months ago is often indistinguishable from code that someone else has written
|
||||
+ You want people to use your code because you think that others might find it useful. However, people need to _understand why_ your code might be useful for them, before they decide to use it
|
||||
+ You want people to _help out_. If you don’t have documentation, you will _miss out_ on a whole class of contributors
|
||||
+ You want to be a _better_ writer
|
||||
+ It doesn’t matter how good your software is, because if the documentation is not good enough, people will not use it.
|
||||
Even if for some reason they have to use it because they have no choice, without good documentation, they won’t use it effectively or the way you’d like them to
|
||||
+ THE MAJORITY OF PEOPLE GLANCE AND LEAVE. Make it pretty so that it's easier for them to star before they leave. The more stars you have, the likelier it is that serious developers will use your repo
|
||||
+ You will be using your code in 6 months. Code that you wrote 6 months ago is often indistinguishable from code that someone else has written
|
||||
+ You want people to use your code because you think that others might find it useful. However, people need to understand why your code might be useful for them, before they decide to use it
|
||||
+ You want people to help out. If you don’t have documentation, you will miss out on a whole class of contributors
|
||||
+ You want to be a better writer
|
||||
|
||||
## 🚦 The DO's and DON'Ts of Documentation<a name = "dos_and_donts"></a>
|
||||
**✔️ DO'S:**
|
||||
+ Keep a lighthearted friendly tone. Treat the reader as someone who doesn't have a lot of _knowledge_ about the topic but is very interested
|
||||
+ Keep things _brief_
|
||||
+ Use _headings_ frequently. This breaks things up when reading and often it is good for linking to specific information
|
||||
+ Link to other places in the documentation often but only for additional information. Readers should not have to navigate through several pages to find the information that they need about _one specific thing_. Just _inline_ the immediately relevant information and link off if they want to know more
|
||||
## 📢 Best Practices<a name = "best_practices"></a>
|
||||
**✔️ Things to remember:**
|
||||
+ Keep a lighthearted friendly tone. Treat the reader as someone who doesn't have a lot of knowledge about the topic but is very interested
|
||||
+ Keep things brief
|
||||
+ Use headings frequently. This breaks things up when reading and often it is good for linking to specific information
|
||||
+ Link to other places in the documentation often but only for additional information. Readers should not have to navigate through several pages to find the information that they need about one specific thing. Just inline the immediately relevant information and link off if they want to know more
|
||||
+ Use as many code snippets, CLI, etc. examples as possible. Show the reader what you mean
|
||||
+ Gently _introduce a guide_ before diving into technical details. This gives context and readers are more likely to stay engaged longer
|
||||
+ Gently introduce a guide before diving into technical details. This gives context and readers are more likely to stay engaged longer
|
||||
+ It is always good to describe the functionality of the various files in your project
|
||||
|
||||
**❌ DON'TS:**
|
||||
+ Don't assume _prior knowledge_ about the topic. If you want to appeal to a large audience, then you are going to have people with very diverse backgrounds
|
||||
+ Don't use _idioms_. Speak using more formal terms that are well defined. This makes it easier for non-native English speakers and for translations to be written
|
||||
**❌ Things you should avoid:**
|
||||
+ Don't assume prior knowledge about the topic. If you want to appeal to a large audience, then you are going to have people with very diverse backgrounds
|
||||
+ Don't use idioms. Speak using more formal terms that are well defined. This makes it easier for non-native English speakers and for translations to be written
|
||||
+ 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)
|
||||
@@ -83,7 +83,7 @@ Even if for some reason they have to use it because they have no choice, without
|
||||
- [feedmereadmes](https://github.com/LappleApple/feedmereadmes) - Free README editing + feedback to make your open-source projects grow. See the README maturity model to help you keep going
|
||||
- [maintainer.io](https://maintainer.io/) - Free README standardization and feedback if you click on 'Book an audit'
|
||||
|
||||
## 📚 Acknowledgements <a name = "acknowledgements"></a>
|
||||
## 🎊 Acknowledgements <a name = "acknowledgements"></a>
|
||||
1. [Documenting your projects on GitHub](https://guides.github.com/features/wikis/) - _GitHub Guides_
|
||||
2. [documentation-handbook](https://github.com/jamiebuilds/documentation-handbook) - _jamiebuilds_
|
||||
3. [Documentation Guide](https://www.writethedocs.org/guide/) - _Write the Docs_
|
||||
|
Reference in New Issue
Block a user