| Firebird Documentation Index → Firebird Docwriting-Anleitung |
|
|
|
21. Juli 2013 – Dokumentenversion 1.3-de - Deutsche Übersetzung
Inhaltsverzeichnis
Dieser Leitfaden behandelt die verschiedenen Aspekte des Schreibens von Dokumentation für Firebird. Er ist gedacht für Menschen, die helfen, Dokumentation für das Firebird-Projekt zu schreiben, oder dies zumindest in Erwägung ziehen. Nach der Lektüre dieses Leitfadens, besitzen Sie alle notwendigen Kenntnisse, um mit dem Schreiben von Firebird-Dokumenten in unserem gewählten Format, DocBook XML, beginnen zu können.
Bevor Sie dieses Handbuch lesen, prüfen Sie, ob Sie bereits folgendes wissen:
Was das Firebird manual Modul ist.
Was CVS ist und wie ein CVS-Client verwendet wird, um das aktuelle manual Modul herunterzuladen.
Wie die aktuelle Firebird-Dokumentation mittels des heruntergeladenen manual Modul funktioniert.
Dieses Wissen ist wichtig, wenn Sie sich daranmachen wollen, Daten zu unserem Dokumentations-Projekt beizutragen. Wenn Sie sich unsicher an einem oder mehreren dieser Punkte fühlen, lesen Sie zunächst das Firebird Docbuilding Howto, und kehren Sie dann hierher zurück.
Wir starten mit ein paar kurzen Kapiteln über:
Die firebird-docs mailing list.
Auswahl eines Themas.
Erstellung eines Abrisses für Ihr Dokument.
Danach werden wir einige Zeit benötigen, um die Grundlagen der DocBook XML zu erörtern, denn das ist das Format, dass wir gern von Ihnen bekommen möchten. Dies bezieht folgendes ein:
DocBook XML – was ist das?
Gründe weshalb wir DocBook anderen Formaten vorziehen.
Werkzeuge, die Sie verwenden können, um DocBook-Texte zu erstellen.
Nicht tragisch, wenn Ihnen DocBook bis jetzt nichts sagt: das benötigte Wissen können Sie innerhalb kürzester Zeit (weniger als eine Stunde) aneignen, und die Chancen, dass Sie hiervon bei anderen Projekten profitieren ist sehr hoch.
Der nächste Abschnitt behandelt das Schreiben der Dokumente selbst - das Docwriting:
Erstellen des eigentlichen Dokuments.
Nutzung der DocBook-Elemente.
Ein, zwei Worte zu Sprache und Schreibstil.
Copyrights und die Public Documentation License.
Abschließend, werden wir Ihnen zeigen, wie Sie Ihr fertiges Dokument zum Firebird-Projekt hinzufügen. Hauptthemen dieses Abschnitts sind:
Commiting des fertiggestellten Dokuments zum manual Modul.
Wo Sie die Commit-Rechte erhalten, wenn Sie noch keine besitzen sollten.
Was man tut oder besser nicht tut, sobald man die Commit-Rechte hat.
Veröffentlichung von HTML- und PDF-Versionen auf der Firebird-Webseite.
|
| Firebird Documentation Index → Firebird Docwriting-Anleitung |