Appendix DG2. 文書化

Table of Contents
文書化に関するロードマップ
文書化プロジェクト
文書化用ソース
文書の構築
マニュアルページ
バージョン 6.5 用の印刷物の生成
ツールセット
別のツールキット

文書化の目的は、Postgres の学習、利用、 及び、開発をより容易にすることです。文書群は Postgres システム、言語、インタフェース についてを記述しなければなりません。それは一般的な質問を解決し、ま た、ユーザがメーリングリストによるサポートに頼らなくても独力で回答 を見つけられるようなものでなければなりません。

文書化に関するロードマップ

Postgres には、次の 4 つの主な文書化形 式があります。

Table DG2-1. Postgres 文書成果物

ファイル 説明
./COPYRIGHT著作権に関する注意書き
./INSTALL インストール手順( sgml->rtf-> テキストの順に変換された テキスト)
./README前置きとなる情報
./register.txtmake 実行中の登録メッセージ
./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 といったようなファイルと同様、多くの使用できるマニュアル ページもあります。