推奨事項

自動でフォーマットしないエディタを使ってください

ドキュメンテーションを編集するために、 一般的に、正式なXMLエディタを使用するべきではありません。 そのようなエディタは、通常、それらの独自の標準に合わせるために、 既存のドキュメントを自動的にフォーマットします。 および/または、docbook 標準に厳密には従いません。 例えば、それらはCDATAタグを消したり、 4スペースの間隔をタブや2スペースに変えたりすることを経験しています。

スタイル・ガイドラインは、通常のdiffツールを用いて 変更した行を翻訳者が確認できるようにするために主に書かれました。 自動フォーマットは、この処理をより難しくします。

イメージを使ってください

Good images and diagrams can improve readability and comprehension. Use them whenever they will assist in these goals. Images should be placed in the documentation/manual/en/figures/ directory, and be named after the section identifier in which they occur.

ケースの例を使ってください

Look for good use cases submitted by the community, especially those posted in proposal comments or on one of the mailing lists. Examples often illustrate usage far better than the narrative does.

When writing your examples for inclusion in the manual, follow all coding standards and documentation standards.

phpdocの内容を繰り返すことを避けてください

The manual is intended to be a reference guide for end-user usage. Replicating the phpdoc documentation for internal-use components and classes is not wanted, and the narrative should be focussed on usage, not the internal workings. In any case, at this time, we would like the documentation teams to focus on translating the English manual, not the phpdoc comments.

リンクを使ってください

ドキュメントを繰り返す代わりに、 マニュアルの他のセクションや外部のソースにリンクしてください。

マニュアルの他のセクションへのリンクを <link>タグ(リンクのテキストを用意しなければいけません) を使って実施できるでしょう。

<para>
    "Link" links to a section, using descriptive text: <link
        linkend="doc-standard.recommendations.links">documentation on
        links</link>.
</para>

外部リソースにリンクするには、<ulink>を使ってください。

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