faq:documentation
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| faq:documentation [2017-09-11 12:41] – [Wikis are good for documentation] 213.164.18.186 | faq:documentation [2024-02-12 17:17] (current) – [Wikis are good for documentation] 45.91.23.76 | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== What makes DokuWiki so great for Documentation ? ====== | + | ====== What makes DokuWiki so great for Documentation? |
| ===== Wikis are good for documentation ===== | ===== Wikis are good for documentation ===== | ||
| + | |||
| * Easy to start: you can share unfinished content early, exposed to many eyes | * Easy to start: you can share unfinished content early, exposed to many eyes | ||
| * Have a simple, consistent page layout | * Have a simple, consistent page layout | ||
| * Easy to create and maintain structured, up-to-date documents: | * Easy to create and maintain structured, up-to-date documents: | ||
| * collaborative | * collaborative | ||
| - | + | * easy to access through the web, with simple login or without any login | |
| + | * easy to modify, no need to know HTML | ||
| + | * easy to link pages | ||
| + | * easy to create simple and consistent pages | ||
| + | * easy to search | ||
| + | * easy to extend with external pages | ||
| + | * Don't need to go to another colleague or IT dept to update the documentation = low resistance to keeping documentation up to date. | ||
| ===== DokuWiki is even better for documentation ===== | ===== DokuWiki is even better for documentation ===== | ||
| + | |||
| * Easy to modify: | * Easy to modify: | ||
| * section editing | * section editing | ||
| Line 22: | Line 29: | ||
| * Simple but powerful Configuration Manager interface for control over features of not only DokuWiki core but also most plugins and themes. If you are not a PHP expert or don't have time to waste fiddling with conf -- no problem! :-D | * Simple but powerful Configuration Manager interface for control over features of not only DokuWiki core but also most plugins and themes. If you are not a PHP expert or don't have time to waste fiddling with conf -- no problem! :-D | ||
| * Datafiles are stored in plain text, so: | * Datafiles are stored in plain text, so: | ||
| - | * are readable even if your server goes down | + | * are readable even if your DokuWiki installation doesn' |
| - | * easy to back up, through server scripts or FTP/sFTP | + | * easy to back up, through server scripts or FTP/SFTP |
| * can easily be read, modified, compared, generated with external (non-wiki) programs | * can easily be read, modified, compared, generated with external (non-wiki) programs | ||
| + | * and easily moved from one DokuWiki-installation to another | ||
| * All those little gimmicks that make documentation fun: [[: | * All those little gimmicks that make documentation fun: [[: | ||
| * Huge amount of available [[: | * Huge amount of available [[: | ||
| * Maybe more I can't remember ;-) | * Maybe more I can't remember ;-) | ||
faq/documentation.1505126492.txt.gz · Last modified: 2017-09-11 12:41 by 213.164.18.186