FreeBSD ドキュメンテーションプロジェクト: 進行中のプロジェクト
いま進行中のプロジェクトの一覧です (つまり freebsd-doc メーリングリストで活発に行われているものです)。
もしあなたがこれらのどれかに貢献できると思えたら、 ためらうことなく立ち上がり参加して下さい。 あなたはそのプロジェクトの責任者と連絡をとり、 あなたにどの作業をしてもらうかを見つけてもらうべきです。 新規プロジェクトについてのアイディアがあれば、 FreeBSD-doc@FreeBSD.org へメールを送ってください。
- ドキュメンテーションプロジェクトの TODO リスト
- ドキュメントの公開障害報告
- ハンドブックのインデックスの改善
- Advocacy スライド/プレゼンテーションへ貢献する
- ハンドブック および/もしくは FAQ の章を書く
- 新しく文書を書く
- CGI スクリプト
- 多言語 ウェブスクリプト
- FreeBSD ドキュメントの翻訳
- 検索エンジンの強化
ドキュメンテーションプロジェクトの TODO リスト
ドキュメンテーションプロジェクトの TODO リストは、 ドキュメンテーションに関連する、最新の TODO リストです。 このリストは、毎月 FreeBSD-doc@FreeBSD.org メーリングリストに流れます。 FreeBSD ドキュメンテーションセットを改善したい考えているのであれば、 まずは TODO リストにある項目からはじめてください。
ドキュメントの公開障害報告
最新の FreeBSD の障害報告は GNATS データベースを用いて追跡されています。 ドキュメントの公開障害報告を 見る ことができます。
ハンドブックのインデックスの改善
責任者: FreeBSD-doc <FreeBSD-doc@FreeBSD.org>
概略: FreeBSD ハンドブックの新しい章の多くで、indexterm の指定がなかったり、現在のスキームに対し適切ではない形で primary や secondary indexterm が指定されています。 いくつかの indexterm は listitem の中であったり、 我々のスタイルシートでは許されないような領域に入れられており、 索引においては実際のページ数の変わりに ??? が出力されています。
index の作業は経験を必要とし、 現在の (プリント出力した) インデックスを注意深く通読すること、 スタイルに関して Chicago マニュアルや、 インデックスに関連する他のスタイルブックを読むことが強く推奨されます。 過去に修正されたインデックスのエラーについては、 chapter.xml ファイルの CVS の履歴をご覧ください。 indexterm に対する変更を行なった後には、 ハンドブックのポストスクリプト版を確認することが必須です。 長い単語や、深く入れ子となった indexterm が用いられると、 2 カラムの出力がおかしくなったり、 ページ番号が ??? と表示されたりします。
doc/share/misc/indexreport.pl と呼ばれるスクリプトを用いると、 <indexterms> が使われていない SGML ファイルを発見できます。
Advocacy スライド/プレゼンテーションに貢献する
責任者: FreeBSD-doc <FreeBSD-doc@FreeBSD.org>, Murray Stokely <murray@FreeBSD.org>
概略: DocBook-slides DTD のプレゼンテーションマークアップが、 ドキュメンテーションセットの doc/en_US.ISO8859-1/slides に追加されました。 多くの advocacy コンテンツが必要です。 また、リリースノートや我々のドキュメンテーションセットの XML コンテンツから、'make' を使って最新のスライドを構築するためのスタイルシートに関する作業も必要です。 この機能を使った簡単な例となるプレゼンテーションがコミットされましたが、 もっと作業が必要です! そして、デフォルトの DocBook Slides XSL-FO スタイルシートがとても厳密なスライドを作成してしまうので、 (Java ベースの XSLT プロセッサを用いた (Passive TeX はスライドに関して限定的です)) print/PDF 出力のためのスタイルシートは、改善の余地があります。
ハンドブック および/もしくは FAQ の章を書く
責任者: おりません
概略: FAQ やハンドブックには中身が空の章が残っており、 埋める必要があります。 もしあなたが作業を終わらせるためにちょうどこれらのドキュメントを使わなくてはいけなかったということがあったり、 またはそれらに足りないところを見つけたときには、 是非時間を見つけてあなたの経験を考えられる限り詳しく書いて下さい。
または、もしあなたが FAQ および/もしくは ハンドブックの中の 空な部分でなにかしなくてはならないことがちょうどあったとしたならば、 新しい章を書くことも考えてみて下さい。 そのときは上に述べたような方法で提出してください。
新しく文書を書く
FreeBSD のための新しい SCSI レイヤ (CAM)
責任者: <doc@FreeBSD.org>, <scsi@FreeBSD.org>
概略: FreeBSD SCSI サブシステムの設計と実装 には 最初のスナップショットがあります。
CGI スクリプト
責任者: <doc@FreeBSD.org>, Wolfram Schneider <wosch@FreeBSD.org>
概要: Perl の FreeBSD::Ports モジュールを使うように CGI スクリプト url.cgi, ports.cgi, pds.cgi と スクリプト portindex を修正する。 これらのモジュールは入念にテストする必要があります。
多言語 ウェブスクリプト
責任者: <doc@FreeBSD.org>
概略:
私たちの主なウェブページは (アメリカ) 英語で書かれています。FreeBSD 翻訳プロジェクトでは、 ウェブページやハンドブック、FAQ を他の言語に翻訳しています。
私たちは、CGI スクリプトや Web を構築するためのスクリプトも翻訳しなければなりません。 これらのスクリプトは、一つの言語だけでなく、複数の言語をサポートするべきです。 ほとんどのスクリプトは perl で書かれています。
- www/en/ports/portindex と www/ja/ports/portindex を一つの perl スクリプトに統合する。英語と日本語の出力に対するオプションを加える。
FreeBSD ドキュメントの翻訳
責任者: <doc@FreeBSD.org>
FreeBSD ドキュメント (Web ページ、FAQ、ハンドブック、マニュアルページ) を 他の言語に翻訳します。 FreeBSD 翻訳プロジェクト を 見てください。
検索エンジンの強化
責任者: Eric Anderson <anderson@centtech.com>
ウェブサイトを検索する場合、検索エンジンの出力する結果には、 例えば FAQ34.html のように、見つかったファイル名が含まれています。
もし、その検索結果に質問文が含まれていれば、 ユーザーは関係があるものなのかどうか見定められるため、 より便利なものになるでしょう。