This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | |||
adding_articles [2011/04/05 05:47] jochen completed a sentence |
adding_articles [2011/04/05 05:48] (current) jochen rephrased |
||
---|---|---|---|
Line 15: | Line 15: | ||
===== Suggested structure ===== | ===== Suggested structure ===== | ||
==== Instruction article ==== | ==== Instruction article ==== | ||
- | As with this very article, I (and this is just a personal preference of mine), I like to follow this kind of (lose) structure when writing a manual (answering each of the questions in the requirements): | + | As with this very article, I (and this really is just a personal preference of mine) like to follow this kind of (lose) structure when writing a manual (answering each of the questions in the requirements): |
* Motivation | * Motivation | ||
* Requirements | * Requirements | ||
* Conditional differences for cases | * Conditional differences for cases | ||
- | * Additional background information | + | * Additional background information (if required) |
* Instructions (with sub-sections for each case) | * Instructions (with sub-sections for each case) | ||
* Examples | * Examples | ||
- | * Links to articles with additional information (e.g. follow-up steps, etc.) | + | * Links to articles or external sources with additional information (e.g. follow-up steps, etc.) |
==== Reference article ==== | ==== Reference article ==== |