Unix は幾度となく (そう言われるのも故ある事だったのですが) - 覚えるのが難しいと言われてきました. ツールを基本にして - コンピューティングシステムをつくる - という方法論は確かに強力ですが, - しばしばユーザは素っ気のないマニュアルによってにっちも - さっちもいかない状態へ追い込まれています. 個々のツール - に関して詳しい記述がなされてはいても, 日々の作業で - いつ, どのようにしてそのツールを使用するのか, あるいは - なぜそのツールを使用するのかを説明してある事は - ほとんどありません. ツールをどのような - 状況で使用するかを説明したすばらしい本が数多く - 書かれてきましたし, そのうちのいくつかは FreeBSD を使う - すべての人に強くお勧めできるものです. しかし, どの - Unix システムもおのおのクセを持っているので, - 文書化されたものを全体として見ると, 実際のシステムとの - ギャップがいくつもあるものです.
+今まで触れたことのない, 複雑なオペレーティングシステムとつきあうのは, + その OS の GUI がどんなに華やかであっても, いつだって難しい作業です. + そして, それは FreeBSD でも何ら異なるところはありません.
-FreeBSD ドキュメンテーションプロジェクトの目標は, まさにこの - ギャップを埋めることにあります. 具体的には,
+確かに, BSD Unix (と, もっと広範な意味での Unix) + に関する書籍はたくさん存在します. + しかし, FreeBSD には FreeBSD なりの独特な機能や手続き, + クセがあります. +
+それに加えて, + Unix-like なオペレーティングシステムに触れるのは FreeBSD + が初めてだというユーザもたくさん存在します. + ですから, + 質の良い正確なドキュメンテーションが利用可能であることがもっとも大切なのです. +
+ +FreeBSD ドキュメンテーションプロジェクトは, + ユーザがこの隔たりを埋めるのを助けるために存在します. + プロジェクトには二種類の作業が存在します.
+ドキュメンテーションプロジェクトのメンバは, + ドキュメンテーションを書き, + FreeBSD ドキュメンテーション集の一部として寄託します. +
ドキュメンテーションプロジェクトのメンバは, + FreeBSD ドキュメンテーション集の体裁や構成について議論し, + 編集を加えます.
+ 進行中のプロジェクト+ +現在, ドキュメンテーションの努力の一環として, + 幾つもプロジェクトが進行中です. + リストに目を通して, + あなたにもできることがないかどうか調べてみてください. + |
-
- FAQ の目標は, FreeBSD に関する情報を扱ういくつもの - ニュースグループやメーリングリストでなされた, あるいは - なされるであろう一般的な質問を簡潔な - Q & A 形式で提供することです. 長い, こみいった回答は - この形式にそぐいません.
+FAQ よりももっと深い議論を必要とする話題は, FreeBSD ハンドブック - にまとめられます. 今のハンドブックはまだ何も書かれていない - 章や節がたくさんあるせいで, まるで骸骨みたいです. - 英知あふれる言葉で満たされるのを待っていますよ.
+このページでは, + どのような人々がドキュメンテーションプロジェクトを構成しているのか, + どうやったらあなたも参加できるのか説明しています.
-FreeBSD の他のプロジェクトと同じように, ドキュメンテーション - プロジェクトも惜しみないユーザの貢献に - 支えられています. プロジェクトの助けとして, 文書化に関する - 問題を議論し, 製作者が情報交換するためのメーリングリストが - つくられています. 叩き台の文章を送ったり - 編集に時間を割いてしもいいと - 思われる方は, 次のように本文に書いたメールを - - majordomo@FreeBSD.ORG まで送ってください.
+このページでは, FreeBSD ドキュメンテーション集の構成と, + ドキュメンテーションプロジェクトが, + それぞれの要素に対して行っている作業について概説しています.
-subscribe freebsd-doc+
(FreeBSD 関連のメーリングリストについて完全な情報を得たい - 方は, ハンドブックの中の - - メーリングリストの項を参照してください.)
+プロジェクトはドキュメンテーションのために SGML + を使用することにしています. このページでは, + SGML でドキュメンテーションをつくる方法を概説し, + 興味を持った読み手に, SGML に関する更なるリソースを教えています.
-今ある文書の訂正や追加は, 新しい章を書いて送るのと - 同じくらい歓迎されます. それ以外のバージョンに言及する - 十分な理由がない限り, すべてのドキュメントは - FreeBSD-stable ブランチの最新リリースの状態に沿うものでなくては - なりません. そうでない場合は, その情報がどのバージョンに - 関するものなのかを明記してください.
+ドキュメンテーションを寄託するのは, + プロジェクトに参加する最良の方法であり, + FreeBSD の使用をより簡単にする助けでもあります. + このページでは, 寄託したドキュメントがすぐに査読を受けられるような, + 最良の寄託法を説明しています.
-今ある文書の訂正や追加を送る時には,
- FreeBSD-current に含まれる文書と訂正後の文書の差分を
- context diff 形式で送ることが
- 推奨されます.
- (context biff の作り方の詳細については diff(1)
- のマニュアルをご覧ください).
- FreeBSD-current のハンドブックは,
ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/doc/handbook- -
から, FAQは,
- -ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/doc/FAQ- -
から手に入ります. 差分は freebsd-doc@FreeBSD.ORG - へ送ってください. 内容が検討されます.
- -他の FreeBSD ユーザにとっても興味深い話題の専門知識に - 自信があって, しかもその話題が FAQ にもハンドブックにも - 載っていない場合, あなたの知恵をどちらかに取り入れるのに - やぶさかではありません. 叩き台を送りたいけれども何が - 必要とされているのかわからないという方は, - ハンドブックと - FAQ を眺めて, - あなたが何か見落としていないか - よく確かめてみてください. 特に, ハンドブックには - 非常によくできた目次がついていますが, アスタリスク (*) - のついたセクションは今のところ何も書かれていなくて, - 熱意ある書き手を待っている状態です.
- -今のところ, 新しい叩き台を送る時には, Docbook DTD に - 則した SGML 形式が推奨されています. 現在, Linuxdoc DTD から - Docbook へ形式を移行している真っ只中なので, ソースとなる - 文書をどうやって別の形式に改めるかについては, 今の時点では - はっきりとは定まっていません. - この問題に関するアナウンスは freebsd-doc メーリングリスト - の中で行われます. - - Docbook に関する文書とリソースのページはこちら. もっとよく - 知りたいという方はどうぞ.
- -SGML があまり好きでない方は, LaTeX 形式で送ってもらっても - かまいません. ほとんど何の苦も無く SGML に変換できるからです. - それもだめだという場合には, ただのテキスト形式で送って - もらえれば十分です.
- -編集に関する一般的なガイドラインをいくつか述べておきます.
- -