Appendix B. ドキュメント

Table of Contents
B.1. DocBook
B.2. ツールセット
B.3. ドキュメントの作成
B.4. ドキュメントの起草
B.5. スタイルガイド

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

加えて、PostgreSQL ソースツリー全体にわたりさまざまな実装に関する問題を記述したプレーンテキストの README ファイルが数多くあります。

ドキュメントはいくつかの「冊子」で構成されています

すべての「冊子」は HTML と PostScript として提供されています。リファレンスマニュアルにはマニュアルページとして配布されているリファレンス項目があります。

HTML によるドキュメントとマニュアルページは標準配布物の一部として提供されていて、デフォルトでインストールされます。Postscript 形式のドキュメントは別途ダウンロードすることができます。

B.1. DocBook

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

DocBook を書く人は出来上がりの細部について気を使わずに技術ドキュメントの構造と内容を指定できます。ドキュメントスタイルは最終的な一つの形式にもってゆくため、どのようにその内容を解釈するかを定義します。DocBook は OASIS グループによりメンテナンスされています。公式 DocBook サイトには役にたつ入門用と参照用のドキュメント、そして O'Reilly 社の本の完全版をオンラインで読めます。FreeBSD ドキュメントプロジェクトでも同様に DocBook を使用していて考慮するに値する数多くのスタイルに関する指針を含め、役立つ情報があります。