| | 1 | [wiki:howto <- Back to the HOWTO section] |
| | 2 | |
| | 3 | = How to write a '''How To''' document = |
| | 4 | |
| | 5 | * Audience: All |
| | 6 | * Requires: None |
| | 7 | |
| | 8 | == Introduction == |
| | 9 | |
| | 10 | This is some notes on writing a how to document. |
| | 11 | |
| | 12 | == Notes == |
| | 13 | |
| | 14 | * The title of the how to document should be in the form: ''How to action object'' where'''action''' is an action taken against '''object.''' For example: |
| | 15 | How To Install an Older Version of a Port |
| | 16 | * The url of the document should be the same as the title minus '''How to,''' with articles and (possibly) adjectives removed and in CamelCase (so that it can be referred to in wiki syntax). For example: |
| | 17 | InstallOlderVersion |
| | 18 | * Use the HowToTemplate if it will fit your how to. |
| | 19 | * When I get enough notes I will organize them into a proper how to. |
| | 20 | |
| | 21 | [wiki:howto <- Back to the HOWTO section] |
