This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
adding_articles [2010/05/27 00:46] jochen |
adding_articles [2011/04/05 05:48] jochen rephrased |
||
---|---|---|---|
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 create/edit a wiki page), you should have access to a web browser with JavaScript and stylesheet support, as well as a stable internet connection. If you need to add images, you might want to install an image editing program (e.g. Adobe Photoshop or The GIMP). |
===== 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 ==== |