Empfehlungen

Editoren ohne Autoformatierung verwenden

Für die Bearbeitung der Dokumentation sollten typischerweise keine formalen XML-Editoren verwendet werden. Solche Editoren formatieren bestehende Dokumente normalerweise so, dass diese ihren eigenen Standards folgen und folgen dem Docbook Standard nicht strikt. Als Beispiel haben wir gesehen das sie die CDATA Tags entfernen, die Trennung von 4 Leerzeichen zu Tabs oder 2 Leerzeichen ändern, usw.

Die Styling Richtlinien wurde großteils geschrieben, um Übersetzern zu helfen, damit diese durch Verwendung von normalen diff-Tools erkennen, welche Zeilen sich geändert haben. Die automatische Formatierung macht diesen Prozess viel schwieriger.

Verwendung von Bildern

Gute Bilder und Diagramme können die Lesbarkeit und das Verständnis erhöhen. Sie sollten immer dann verwendet werden, wenn sie diesen Zielen helfen. Bilder sollten im Verzeichnis documentation/manual/en/figures/ platziert, und nach dem Kapitel benannt werden, in dem sie vorkommen.

Gute Fallbeispiele

Man sollte nach guten Fallbeispielen suchen, die von der Community verbreitet werden. Speziell jene, die in den Kommentaren der Proposals oder einer der Mailing Listen gesendet werden. Beispiel zeigen oft viel besser die Verwendung, als es Beschreibungen tun.

Wenn man Beispiele für die Aufnahme in das Handbuch schreibt, sollte man allen Coding Standards und Dokumentations Standards folgen.

Vermeide die Wiederholung von phpdoc Inhalten

Das Handbuch ist dazu gedacht, ein Referenzhandbuch für die Verwendung durch Endbenutzer zu sein. Die Wiederholung von phpdoc Dokumentation für intern verwendete Komponenten und Klassen ist nicht erwünscht, und die Beschreibungen sollten auf die Verwendung fokussiert sein, und nicht der internen Arbeitsweise. In jedem Fall und zu jeder Zeit wollen wir, dass sich die Dokumentations-Teams auf die Übersetzung des englischen Handbuchs und nicht auf ide phpdoc Kommentare fokussiert.

Verwendung von Links

Links sollten zu anderen Abschnitten des Handbuchs oder externen Quellen verweisen, statt Dokumentation zu wiederholen.

Die Verlinkung zu anderen Abschnitten des Handbuchs kann durchgeführt werden, indem das <link> Tag verwendet wird (für welches man den Link Text selbst angeben muß).

<para>
    "Link" verweist zu einer Sektion, und verwendet beschreibenden Text: <link
        linkend="doc-standard.recommendations.links">Dokumentation zum
        Link</link>.
</para>

Um auf eine externe Ressource zu verweisen, muss <ulink> verwendet werden:

<para>
    Die <ulink url="http://framework.zend.com/">Zend Framework Seite</ulink>.
</para>