他のバージョンの文書9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

付録 G. ドキュメント作成

目次
G.1. DocBook
G.2. ツールセット
G.3. ドキュメントのビルド
G.4. ドキュメントの起草
G.5. スタイルガイド

PostgreSQLには4つの基本的なドキュメントフォーマットがあります。

さらに、PostgreSQLソースツリー全体にわたり、様々な実装に関する問題を記述した平文のREADMEファイルが数多くあります。

HTMLドキュメントとマニュアルページは標準の配布物の一部でデフォルトでインストールされます。 PDFとPostscript形式のドキュメントは別途ダウンロードすることで入手できます。

G.1. DocBook

ドキュメントソースは、見たところHTMLに似たマークアップ言語であるDocBookで書かれています。 これらいずれの言語も、元々他の言語を記述する言語であるStandard Generalized Markup LanguageSGMLのアプリケーションです。 ここからは、DocBookとSGML両方の用語が使用されますが、技術的に相互の互換性はありません。

DocBookを使用して作成することで、最終的な見栄えがどうなるかに気を遣わずに技術ドキュメントの構造と内容を指定できます。 あるドキュメントスタイルによりいくつか存在する最終形式の1つに内容をどのように翻訳するかが定義されます。 DocBookはOASISグループによりメンテナンスされています。 NewbieDoc Docbook Guideは初心者にとりとても役に立ちます。 公式DocBookサイトには役に立つ入門用と参照用のドキュメント、そしてO'Reilly社の本の完全版をオンラインで読めます。 FreeBSDドキュメントプロジェクトでも同様にDocBookを使用していて注目すべき数多くのスタイルに関する指針を含め、役立つ情報があります。