|
|
| Zeile 1: |
Zeile 1: |
| Zur <b>Softwaredokumentation</b> von [[Linux]] gibt es verschiedenste Informationsquellen.
| | Als <b>Softwaredokumentation</b> wird die [[Dokumentation]] einer [[Software]] (z. B. eines [[Anwendungsprogramm]]s). Es gibt zwei Hauparten der Softwaredokumentation: |
| | | * die Beschreibung des [[Quellcode]]s, damit es später leichter ist, Fehler zu entdecken oder Änderungen vorzunehmen. |
| * <b>[[Handbuch|Handbücher]]</b> [engl. manpages] können mit [[man]] oder über mit dem [[Konqueror]] über den Kioslave <tt>man:/</tt> angesehen werden
| | * die <b>Benutzerdokumentation</b> beschreibt die Benutzerschnittstelle, erklärt also dem Benutzer die Anwendung des Programms. Zu ihr gehören [[Handbuch|Handbücher]], die Hilfefunktion im Programm selbst und Online-Dokumentationen. Sie sollte in einer für den Benutzer verständlichen Sprache abgefasst sein und Fachbegriffe in einem Glossar erklären. |
| * <b>[[Infoseite]]n</b> können mit [[info]] angesehen werden | |
| * <b>howtos</b> (Anleitungen zu bestimmten Themen in ASCII-Text) unter "/usr/share" oder "/usr/share/doc" sowie online
| |
| * <b>mini-howtos</b> (kurze howtos, meist spezieller Natur) unter "/usr/share" oder "/usr/share/doc" sowie online
| |
| * <b>FAQs</b> (frequently asked questions) beantworten häufig vorkommende, konkrete Fragen zu einem eng umschriebenen Thema und finden sich unter "/usr/share/doc" sowie online
| |
| * <b>guides</b> (sehr umfangreiche Texte bzw. Bücher, häufig als .ps, .dvi oder .pdf-Dokumente) unter "/usr/share/doc" sowie online
| |
| * <b>Paketinformationen</b> (meist mindestens die Dokumente "README", "TODO", "CHANGES" und "BUGS") unter "/usr/share/doc/packages" oder "/usr/share" | |
| * <b>[[help]]</b> ist ein im Binärcode eingebauter Shellbefehl (z. B. "help type")
| |
| * <b>Optionen</b> (im Binärcode vieler Programme enthalten), z. B.
| |
| ** <tt> Befehl --help</tt>
| |
| ** <tt> Befehl -h</tt>
| |
| ** <tt> Befehl -?</tt>
| |
| ** <tt> Befehl -v</tt>
| |
| ** <tt> Befehl -V</tt>
| |
| * <b>World Wide Web</b>
| |
| ** [http://www.google.de/linux?hl=de Linuxgoogle] [Deutsch]
| |
| ** [http://www.tldp.org/ The Linux Documentation Project / TLDP]
| |
| ** [http://www.linuxhaven.de/dlhp/ Deutsches Linux HOWTO Projekt] (Marco Budde)
| |
| ** [http://powerusersbbs.com/linux/german/linux-doc.html Deutsche Linux Dokumentation]
| |
| ** [http://www.oreilly.de/openbook/ Openbooks Project] (O'Reilly)
| |
| ** [http://www.boutell.com/lsm/ Linux Software Map] (Boutell.com)
| |
| ** [http://www.ibiblio.org/mdw/HOWTO/German-HOWTO.html German Howto] (Winfried Trümper)
| |
| ** [http://freshmeat.net/ Freshmeat] - Open Source Software
| |
| ** [http://sourceforge.net/ SourceForge] - Plattform für Entwickler mit CVS-sourcecode-Verwaltung
| |
| * Die <b>Support-Datenbanken</b> der Distributoren bieten Musterlösungen und Antworten auf Fragen, die nur im Zusammenhang mit der betreffenden Distribution auftreten.
| |
| ** [http://www.debianhelp.org/ Debian]
| |
| ** [http://www.mandrakeexpert.com/ Mandrake]
| |
| ** [http://kb.redhat.com/ RedHat]
| |
| ** [http://www.slackware.com/ Slackware]
| |
| ** [http://portal.suse.de/sdb/de/ SuSE Supportdatenbank]
| |
| * Die <b>RFCs</b> (requests for comment) informieren genauer über die dem Internet zugrundeliegenden Protokolle und Konzepte.
| |
| * Linux User Groups (LUG)
| |
| * Mailinglisten
| |
| ** [http://www.securityfocus.com/ SecurityFocus]
| |
| * Newsgruppen
| |
| | |
| Eigene Dokumentation sollten am besten als einfach les- und umwandelbare Textdateien erstellt werden. Aus Dateien mit Endung ".tex" oder ".dvi" können mit dem Programm "dvi" .pdf-, .ljet- und .ps-Dateien usw. generiert werden (LATEX).
| |
|
| |
|
| == Weblinks == | | == Weblinks == |