文書化の目的は、Postgres の学習、利用、 及び、開発をより容易にすることです。文書群は Postgres システム、言語、インタフェース についてを記述しなければなりません。それは一般的な質問を解決し、ま た、ユーザがメーリングリストによるサポートに頼らなくても独力で回答 を見つけられるようなものでなければなりません。
Postgres には、次の 4 つの主な文書化形 式があります。
インストール実施前の情報用の平文。
オンラインでの閲覧、参照用の HTML。
じっくり読んで、そして参照するための印刷物。
素早く参照するための、マニュアルページ
Table DG2-1. Postgres 文書成果物
ファイル | 説明 |
---|---|
./COPYRIGHT | 著作権に関する注意書き |
./INSTALL | インストール手順( sgml->rtf-> テキストの順に変換された テキスト) |
./README | 前置きとなる情報 |
./register.txt | make 実行中の登録メッセージ |
./doc/bug.template | バグ報告用のテンプレート |
./doc/postgres.tar.gz | ( HTML )文書をまとめたもの |
./doc/programmer.ps.gz | プログラマガイド(ポストスクリプト) |
./doc/programmer.tar.gz | プログラマガイド(HTML) |
./doc/reference.ps.gz | レファレンスマニュアル(ポストスクリプト) |
./doc/reference.tar.gz | レファレンスマニュアル(HTML) |
./doc/tutorial.ps.gz | 入門(ポストスクリプト) |
./doc/tutorial.tar.gz | 入門( HTML ) |
./doc/user.ps.gz | ユーザガイド(ポストスクリプト) |
./doc/user.tar.gz | ユーザガイド(HTML) |
Postgres のソースツリーには、平文の README といったようなファイルと同様、多くの使用できるマニュアル ページもあります。