adding_articles
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revisionLast revisionBoth sides next revision | ||
adding_articles [2010/05/26 20:04] – created jochen | adding_articles [2011/04/05 03:47] – completed a sentence 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 ==== | ||
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 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): | ||
* Motivation | * Motivation | ||
Line 22: | Line 23: | ||
* Examples | * Examples | ||
* Links to articles with additional information (e.g. follow-up steps, etc.) | * Links to articles with additional information (e.g. follow-up steps, etc.) | ||
+ | |||
+ | ==== Reference article ==== | ||
+ | Next to the instruction articles, the NeuroElf wiki naturally also contains reference material (functions, file types, UI etc.). For those articles, the Motivation and Requirements sections are obviously not (as) necessary. Hence those articles should focus on | ||
+ | |||
+ | * Reference (e.g. output of 'help FUNCTION_NAME' | ||
+ | * Usage examples | ||
+ | * Background information (where necessary) | ||
+ | * Limitations and/or caveats | ||
+ | * Alternatives (if useful) and | ||
+ | * Supplemental functions, material, etc. | ||
===== Layout instructions ===== | ===== Layout instructions ===== |
adding_articles.txt · Last modified: 2011/04/05 03:48 by jochen