|
| |
Anforderungen
Dokumentation :
Anforderungen : Übersicht
19-Sep-2002/09-Jan-07
Übersicht
Anforderungen an die Quellen einer Dokumentation
Portabel.
Eine portable Datei zu schreiben setzte noch im Dezember 2001 ein
7-Bit ASCII voraus, um die Zeichen zu kodieren. Heutzutage ist ein
7-Bit ASCII die einzige Kodierung, die auf eine riesigen Zahl von
Computern läuft. In Zukunft wird das hoffentlich Unicode sein.
Unicode kann weitaus mehr Buchstaben darstellen als ASCII und wird
genauso portabel sein.
Wenn man Portabilität haben möchte, muss man sicherstellen, dass
die Textquellen auf vielen verschiedenen Computersystemen gelesen
und verändert werden können, auch um die Dokumentation anderen
Programmieren zugänglich machen zu können, was genau das ist, das
den Sinn von Open Source Software ausmacht.
Durchsuchbar.
Daten auf einem Computer sind nur so gut, wie man sie erreichen
kann. Das hört sich ein bisschen komisch an, aber wir vergessen sehr
leicht, dass Dokumentation genau wie Quellcode betreut werden
sollte. Wir möchten die existierende Dokumentation nach einem
bestimmten Satz oder ein Ausdruck durchsuchen können. Deswegen
sollte die Quelle der Dokumentation wenigstens erreichbar von
Standard-Such-Werkzeugen wie zum Beispiel der grep Familie (grep,
agrep, rgrep, sgrep) sein.
Modular.
Ausser wenn wir eine kurze Notiz schreiben, ist es wünschenswert,
dass die Dokumentquellen in logische Teile zerteilt werden können,
zum Beispiel in Abschnitte und dass die ganze Sammlung von
Quelltextdateien immer noch als Ganzes vom Dokumentationssystem
bearbeitet werden kann.
Leicht zu lesen.
Damit Dokumentation ebenso offen wie der Quellcode ist, sollten
die Quellen leicht zu lesen sein, und das System, das die
letztendliche Ausgabe erzeugt sollte leicht zu erlernen sein. Ein
Dokumentationssystem wird besser akzeptiert werden, wenn der
Schreiber -- und später womöglich der Betreuer -- sich auf die
Inhalte mehr konzentrieren kann als auf syntaktischen Quark oder
verstrickte Werkzeugketten.
Anforderungen an die Ausgabe einer Dokumentation
Multiple Ausgabeformate.
Das Dokumentationssystem muss die Möglichkeit haben,
verschieden Ausgabeformate zu erzeugen -- je mehr Formate, desto
besser. Wenigstens HTML und PostScript bzw. PDF müssen
unterstützt werden: HTML zum Lesen auf dem Bildschirm,
PostScript oder PDF für Ausdrucke.
Automatische Erzeugung von Referenzen.
Alle Verweise sollten innerhalb des Dokuments automatisch
aufgelöst werden. Fußnoten, Seitennoten oder Endnoten sollten
gesetzt und ohne die Hilfe des Schreibers nummeriert werden. Der
Index und die Quellenangaben sollten ebenfalls automatisch
erzeugt werden.
Credits
Diese Übersicht basiert auf Linux Gazette: "Dokumentationen
schreiben, Teil 1: POD", von Christoph Spiel, Übersetzung von
Thorsten Mürell (siehe Netmarks zur
Dokumentation von und mit GNU/Linux).
Anmerkungen
| |
 Anforderungen: |
|
Name: Besucher.
Online: 5 aktive User.
|
| Login |
Logout
|
|
|
Benachrichtigen bei Änderungen: |
|
|
|
|
Debian GNU/Linux 3.1 »Sarge«,
mit Debian-Anwenderhandbuch.
DVD-ROM +
Bonus-DVD
 EUR
49,90
(versandkostenfrei)
|
Debian GNU/Linux Power Pack.
von
Peter H. Ganten und
Wulf Alex.
946 Seiten, zwei DVDs
EUR 69,95
(versandkostenfrei) |
|
Ubuntu: |
Ubuntu/Kubuntu 5.10,
mit Handbuch.
EUR
29,90
(versandkostenfrei)
|
|
SuSE
Linux: |
SUSE
Linux 10.0 deutsch.
von Novell
EUR
48,95
(versandkostenfrei)
|
SuSE
Linux 9.3 Professional
von Novell.
EUR
82,99
(versandkostenfrei)
|
SuSE
Linux 9.3 Professional Update.
von Novell
EUR 59,95
(versandkostenfrei) |
|
Red
Hat Linux: |
|
Red Hat Linux
Professional Workstation.
EUR 99,95
(versandkostenfrei)
|
Red Hat Linux 9 Personal.
Red Hat Linux 9 Professional.
ab EUR 39,99
(versandkostenfrei) |
|
 |
Thematisch verwandte Subsites:
Apple,
BSD,
Hardware,
Internet,
Microsoft Windows,
Networking,
Open Content,
Open Source & Free Software,
Politik,
Recht,
Safety,
Security,
Shopping,
Software,
The Tark,
Webworking,
Wissen. |
 |
|
|
Kefk Network :
GNU/Linux |
About |
Wiki.
