adding_articles
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
adding_articles [2010/05/26 22:46] – jochen | adding_articles [2011/04/05 03:48] (current) – rephrased jochen | ||
---|---|---|---|
Line 11: | Line 11: | ||
* do you need images (or formulae) to improve the readability and comprehensibility of the information | * do you need images (or formulae) to improve the readability and comprehensibility of the information | ||
- | As general requirements (to be able to successfully edit | + | As general requirements (to be able to successfully |
===== 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 |
* Motivation | * Motivation | ||
* Requirements | * Requirements | ||
* Conditional differences for cases | * Conditional differences for cases | ||
- | * Additional background information | + | * Additional background information |
* 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 |
==== Reference article ==== | ==== Reference article ==== |
adding_articles.txt · Last modified: 2011/04/05 03:48 by jochen