| title | excerpt |
|---|---|
How to Document Template |
Document always should start with a compelling overview. No headings for overview. In this opening pharagraph, summarize the main points of your how-to. Make sure to explain the utility of your How-To. An overview helps potential readers to determine quickly if a particular how-to matches their interests or needs.
For detailed guideline, please refer to https://forrest.apache.org/howto-howto.html#References
Describe intended audience.
You name the appropriate header. Don't forget that the purpose of how-do document is completing a specific task to solve a problem. Briefly mention that how users will benefit from this how-to.
Enumereate any required knowledge, configuration, or resources to complete this how-to. Provide links to other useful resources. Helping your readers to prepare increases the likelihood that they will continue reading.
Title of this document will be a good heading.
- step 1
- step 1-1
- step 2
- step 3
- step 3-1
When using a bullet list do not insert a new line between items.
Do this.
- step 1
- step 1-1
- step 2
Add one line spacing at the end of list.
Don't do this. This will break the style on the readme.io.
- step 1
- step 1-1
- step 2
For the header, every words except some little words (like, a, the, of, for, which .. ) should start with an uppercase letter
Do not recommend using header size below 4.
- Numbered list
- Numbered list
- Test
- Numbered list
Heading can be ommited. Just summarize what theve have learned in a couple of sentences.
Extend the learning : Provide your reader with a few real-world examples of how the techniques or capabilities gained from your How-To could be applied. Reward the reader for successfully completing the how-to with a few ideas about how it will pay off.