Changes in the English version(1.9->1.10) are merged.
Submitted by: HIROSE Shouichi <shou@kt.rim.or.jp>, Motoyuki Konno <motoyuki@snipe.rim.or.jp>
This commit is contained in:
Hiroyuki Hanai
parent
89696c86c0
commit
e6da12054f
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/www/; revision=2648
2 changed files with 134 additions and 332 deletions
|
|
@ -1,192 +1,93 @@
|
||||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN" [
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" [
|
||||||
<!ENTITY date "$Date: 1997-11-23 22:23:02 $">
|
<!ENTITY date "$Date: 1998-04-06 03:58:01 $">
|
||||||
<!ENTITY title "FreeBSD Documentation Project">
|
<!ENTITY title "FreeBSD Documentation Project">
|
||||||
<!ENTITY % includes SYSTEM "includes.sgml"> %includes;
|
<!ENTITY % includes SYSTEM "includes.sgml"> %includes;
|
||||||
]>
|
]>
|
||||||
<!-- $Id: docproj.sgml,v 1.1.1.1 1997-11-23 22:23:02 max Exp $ -->
|
<!-- $Id: docproj.sgml,v 1.2 1998-04-06 03:58:01 hanai Exp $ -->
|
||||||
<!-- The FreeBSD Japanese Documentation Project -->
|
<!-- The FreeBSD Japanese Documentation Project -->
|
||||||
<!-- Original revision: 1.9 -->
|
<!-- Original revision: 1.10 -->
|
||||||
|
|
||||||
<html>
|
<html>
|
||||||
&header;
|
&header;
|
||||||
|
|
||||||
<h2>目標</h2>
|
<h2>概観</h2>
|
||||||
|
|
||||||
<p>Unix は幾度となく (そう言われるのも故ある事だったのですが)
|
<p>今まで触れたことのない, 複雑なオペレーティングシステムとつきあうのは,
|
||||||
覚えるのが難しいと言われてきました. ツールを基本にして
|
その OS の GUI がどんなに華やかであっても, いつだって難しい作業です.
|
||||||
コンピューティングシステムをつくる
|
そして, それは FreeBSD でも何ら異なるところはありません.</p>
|
||||||
という方法論は確かに強力ですが,
|
|
||||||
しばしばユーザは素っ気のないマニュアルによってにっちも
|
|
||||||
さっちもいかない状態へ追い込まれています. 個々のツール
|
|
||||||
に関して詳しい記述がなされてはいても, 日々の作業で
|
|
||||||
いつ, どのようにしてそのツールを使用するのか, あるいは
|
|
||||||
なぜそのツールを使用するのかを説明してある事は
|
|
||||||
ほとんどありません. ツールをどのような
|
|
||||||
状況で使用するかを説明したすばらしい本が数多く
|
|
||||||
書かれてきましたし, そのうちのいくつかは FreeBSD を使う
|
|
||||||
すべての人に強くお勧めできるものです. しかし, どの
|
|
||||||
Unix システムもおのおのクセを持っているので,
|
|
||||||
文書化されたものを全体として見ると, 実際のシステムとの
|
|
||||||
ギャップがいくつもあるものです.</p>
|
|
||||||
|
|
||||||
<p>FreeBSD ドキュメンテーションプロジェクトの目標は, まさにこの
|
<p>確かに, BSD Unix (と, もっと広範な意味での Unix)
|
||||||
ギャップを埋めることにあります. 具体的には, </p>
|
に関する書籍はたくさん存在します.
|
||||||
|
しかし, FreeBSD には FreeBSD なりの独特な機能や手続き,
|
||||||
|
クセがあります.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>それに加えて,
|
||||||
|
Unix-like なオペレーティングシステムに触れるのは FreeBSD
|
||||||
|
が初めてだというユーザもたくさん存在します.
|
||||||
|
ですから,
|
||||||
|
質の良い正確なドキュメンテーションが利用可能であることがもっとも大切なのです.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>FreeBSD ドキュメンテーションプロジェクトは,
|
||||||
|
ユーザがこの隔たりを埋めるのを助けるために存在します.
|
||||||
|
プロジェクトには二種類の作業が存在します.</p>
|
||||||
|
|
||||||
<ol>
|
<ol>
|
||||||
<li>お店で売っているふつうの Unix のユーザ, 管理者, プログラマ
|
<li><p>ドキュメンテーションプロジェクトのメンバは,
|
||||||
の手引き書には載っていない, FreeBSD に特有の機能, 手続きや
|
ドキュメンテーションを書き,
|
||||||
その他のクセを取り扱うこと. その中で最も重要になるのは次の
|
<em>FreeBSD ドキュメンテーション集</em>の一部として寄託します.
|
||||||
通り.
|
</p></li>
|
||||||
<p></p>
|
|
||||||
<ul>
|
|
||||||
<li>インストールの作業<p></p></li>
|
|
||||||
<li>サポートされるハードウェアとそのトラブルシューティング
|
|
||||||
<p></p></li>
|
|
||||||
<li>システムの設定と調整<p></p></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li>FreeBSDの一般的な話題をほぼ網羅した文書を提供すること.
|
<li><p>ドキュメンテーションプロジェクトのメンバは,
|
||||||
他の手引き書でふれられているかどうかは問題にしない.
|
<em>FreeBSD ドキュメンテーション集</em>の体裁や構成について議論し,
|
||||||
次のような話題を含む.<p></p>
|
編集を加えます.</p></li>
|
||||||
<ul>
|
|
||||||
<li>ネットワークの設定とトラブルシューティング
|
|
||||||
<p></p></li>
|
|
||||||
<li>インターネットサービスプロバイダ (ISP) への情報
|
|
||||||
<p></p></li>
|
|
||||||
<li>一般的なシステム管理<p></p></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
<h2>プロジェクト</h2>
|
<table bgcolor="#ffffcc" border="1" cellpadding="4" width="100%">
|
||||||
|
<tr>
|
||||||
|
<td><h2 align="center"><a href="../docproj/current.html">
|
||||||
|
進行中のプロジェクト</a></h2>
|
||||||
|
|
||||||
|
<p>現在, ドキュメンテーションの努力の一環として,
|
||||||
|
幾つもプロジェクトが<em>進行中です</em>.
|
||||||
|
リストに目を通して,
|
||||||
|
<b>あなた</b>にもできることがないかどうか調べてみてください.
|
||||||
|
</p></td>
|
||||||
|
|
||||||
<p>上の目標をふまえたうえで, ドキュメンテーション
|
</tr>
|
||||||
プロジェクトは二つの方向に的をしぼる事にしました.</p>
|
</table>
|
||||||
<ol>
|
|
||||||
<li><a href = "&FAQbase/FAQ.html">
|
|
||||||
FAQ</a> と, </li>
|
|
||||||
<li><a href = "handbook/handbook.html">
|
|
||||||
FreeBSD ハンドブック</a>です.</li>
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
<p><a href = "&FAQbase/FAQ.html">
|
<h2><a href="../docproj/who.html">
|
||||||
FAQ</a> の目標は, FreeBSD に関する情報を扱ういくつもの
|
我々は何者か, どうしたら参加できるのか</a></h2>
|
||||||
ニュースグループやメーリングリストでなされた, あるいは
|
|
||||||
<em>なされるであろう</em>一般的な質問を簡潔な
|
|
||||||
Q & A 形式で提供することです. 長い, こみいった回答は
|
|
||||||
この形式にそぐいません.</p>
|
|
||||||
|
|
||||||
<p>FAQ よりももっと深い議論を必要とする話題は, <a href =
|
<p>このページでは,
|
||||||
"handbook/handbook.html">FreeBSD ハンドブック</a>
|
どのような人々がドキュメンテーションプロジェクトを構成しているのか,
|
||||||
にまとめられます. 今のハンドブックはまだ何も書かれていない
|
どうやったらあなたも参加できるのか説明しています.</p>
|
||||||
章や節がたくさんあるせいで, まるで骸骨みたいです.
|
|
||||||
英知あふれる言葉で満たされるのを待っていますよ.</p>
|
|
||||||
|
|
||||||
<h2>プロジェクトに貢献する</h2>
|
<h2><a href="../docproj/doc-set.html">FreeBSD ドキュメンテーション集</a></h2>
|
||||||
|
|
||||||
<p>FreeBSD の他のプロジェクトと同じように, ドキュメンテーション
|
<p>このページでは, FreeBSD ドキュメンテーション集の構成と,
|
||||||
プロジェクトも惜しみないユーザの貢献に
|
ドキュメンテーションプロジェクトが,
|
||||||
支えられています. プロジェクトの助けとして, 文書化に関する
|
それぞれの要素に対して行っている作業について概説しています.</p>
|
||||||
問題を議論し, 製作者が情報交換するためのメーリングリストが
|
|
||||||
つくられています. 叩き台の文章を送ったり
|
|
||||||
編集に時間を割いてしもいいと
|
|
||||||
思われる方は, 次のように本文に書いたメールを
|
|
||||||
<a href="mailto:majordomo@FreeBSD.ORG">
|
|
||||||
majordomo@FreeBSD.ORG</a> まで送ってください.</p>
|
|
||||||
|
|
||||||
<blockquote>subscribe freebsd-doc</blockquote>
|
<h2><a href="../docproj/sgml.html">
|
||||||
|
SGML とドキュメンテーションプロジェクト</a></h2>
|
||||||
|
|
||||||
<p>(FreeBSD 関連のメーリングリストについて完全な情報を得たい
|
<p>プロジェクトはドキュメンテーションのために SGML
|
||||||
方は, ハンドブックの中の
|
を使用することにしています. このページでは,
|
||||||
<a href="handbook/eresources:mail.html">
|
SGML でドキュメンテーションをつくる方法を概説し,
|
||||||
メーリングリスト</a>の項を参照してください.)</p>
|
興味を持った読み手に, SGML に関する更なるリソースを教えています.</p>
|
||||||
|
|
||||||
<p>今ある文書の訂正や追加は, 新しい章を書いて送るのと
|
<h2><a href="../docproj/submitting.html">
|
||||||
同じくらい歓迎されます. それ以外のバージョンに言及する
|
ドキュメンテーションを寄託する</a></h2>
|
||||||
十分な理由がない限り, すべてのドキュメントは
|
|
||||||
FreeBSD-stable ブランチの最新リリースの状態に沿うものでなくては
|
|
||||||
なりません. そうでない場合は, その情報がどのバージョンに
|
|
||||||
関するものなのかを明記してください.</p>
|
|
||||||
|
|
||||||
<h3>訂正を送る</h3>
|
<p>ドキュメンテーションを寄託するのは,
|
||||||
|
プロジェクトに参加する最良の方法であり,
|
||||||
|
FreeBSD の使用をより簡単にする助けでもあります.
|
||||||
|
このページでは, 寄託したドキュメントがすぐに査読を受けられるような,
|
||||||
|
最良の寄託法を説明しています.</p>
|
||||||
|
|
||||||
<p>今ある文書の訂正や追加を送る時には,
|
&footer
|
||||||
FreeBSD-current に含まれる文書と訂正後の文書の差分を
|
</body>
|
||||||
<em>context diff</em> 形式で送ることが
|
|
||||||
推奨されます.
|
|
||||||
(context biff の作り方の詳細については <code><a
|
|
||||||
href="http://www.freebsd.org/cgi/man.cgi?diff(1)">diff(1)</a>
|
|
||||||
</code> のマニュアルをご覧ください).
|
|
||||||
FreeBSD-current のハンドブックは, </p>
|
|
||||||
|
|
||||||
<blockquote><a
|
|
||||||
href="ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/doc/handbook">ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/doc/handbook</a></blockquote>
|
|
||||||
|
|
||||||
<p>から, FAQは, </p>
|
|
||||||
|
|
||||||
<blockquote><a
|
|
||||||
href="ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/doc/FAQ">ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/doc/FAQ</a></blockquote>
|
|
||||||
|
|
||||||
<p>から手に入ります. 差分は <a
|
|
||||||
href="mailto:freebsd-doc@FreeBSD.ORG">freebsd-doc@FreeBSD.ORG</a>
|
|
||||||
へ送ってください. 内容が検討されます.</p>
|
|
||||||
|
|
||||||
<h3>新しい叩き台を送る</h3>
|
|
||||||
|
|
||||||
<p>他の FreeBSD ユーザにとっても興味深い話題の専門知識に
|
|
||||||
自信があって, しかもその話題が FAQ にもハンドブックにも
|
|
||||||
載っていない場合, あなたの知恵をどちらかに取り入れるのに
|
|
||||||
やぶさかではありません. 叩き台を送りたいけれども何が
|
|
||||||
必要とされているのかわからないという方は,
|
|
||||||
<a href="handbook/handbook.html">ハンドブック</a>と
|
|
||||||
<a href="&FAQbase/FAQ.html">FAQ</a> を眺めて,
|
|
||||||
<em>あなたが</em>何か見落としていないか
|
|
||||||
よく確かめてみてください. 特に, ハンドブックには
|
|
||||||
非常によくできた目次がついていますが, アスタリスク (*)
|
|
||||||
のついたセクションは今のところ何も書かれていなくて,
|
|
||||||
熱意ある書き手を待っている状態です.</p>
|
|
||||||
|
|
||||||
<p>今のところ, 新しい叩き台を送る時には, Docbook DTD に
|
|
||||||
則した SGML 形式が推奨されています. 現在, Linuxdoc DTD から
|
|
||||||
Docbook へ形式を移行している真っ只中なので, ソースとなる
|
|
||||||
文書をどうやって別の形式に改めるかについては, 今の時点では
|
|
||||||
はっきりとは定まっていません.
|
|
||||||
この問題に関するアナウンスは freebsd-doc <a
|
|
||||||
href="handbook/eresources:mail.html">メーリングリスト</a>
|
|
||||||
の中で行われます.
|
|
||||||
<a href="http://fallout.campusview.indiana.edu/~jfieber/docbook">
|
|
||||||
Docbook に関する文書とリソース</a>のページはこちら. もっとよく
|
|
||||||
知りたいという方はどうぞ.</p>
|
|
||||||
|
|
||||||
<p>SGML があまり好きでない方は, LaTeX 形式で送ってもらっても
|
|
||||||
かまいません. ほとんど何の苦も無く SGML に変換できるからです.
|
|
||||||
それもだめだという場合には, ただのテキスト形式で送って
|
|
||||||
もらえれば十分です.</p>
|
|
||||||
|
|
||||||
<p>編集に関する一般的なガイドラインをいくつか述べておきます.</p>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li>短縮形 (can't, I'm などの形式) を使わないでください.
|
|
||||||
<p></p></li>
|
|
||||||
|
|
||||||
<li>具体的な例をあげてください.<p></p></li>
|
|
||||||
|
|
||||||
<li>相互に参照しあいましょう. HTML版の文書では,
|
|
||||||
ハイパーテキストのリンクを使用することができます.
|
|
||||||
<p></p></li>
|
|
||||||
|
|
||||||
<li>同じ文書の他のセクションで述べられているのと重複する
|
|
||||||
ことを書いてはいけません. そうした方が良いと思われても
|
|
||||||
です. もしあるセクションに今載っている情報があなたの
|
|
||||||
担当している話題を助けるのに十分でないように思われたなら,
|
|
||||||
更なる情報があなたの書いているセクションにあった方が
|
|
||||||
よいか, 参照先のセクションに追加された方がよいかを考えて
|
|
||||||
みてください. もし後者だと思われたなら, 参照先の
|
|
||||||
セクションの担当者と話し合ってみてください.
|
|
||||||
<p></p></li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
&footer
|
|
||||||
</body>
|
|
||||||
</html>
|
</html>
|
||||||
|
|
|
||||||
|
|
@ -1,192 +1,93 @@
|
||||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN" [
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" [
|
||||||
<!ENTITY date "$Date: 1997-11-23 22:23:02 $">
|
<!ENTITY date "$Date: 1998-04-06 03:58:01 $">
|
||||||
<!ENTITY title "FreeBSD Documentation Project">
|
<!ENTITY title "FreeBSD Documentation Project">
|
||||||
<!ENTITY % includes SYSTEM "includes.sgml"> %includes;
|
<!ENTITY % includes SYSTEM "includes.sgml"> %includes;
|
||||||
]>
|
]>
|
||||||
<!-- $Id: docproj.sgml,v 1.1.1.1 1997-11-23 22:23:02 max Exp $ -->
|
<!-- $Id: docproj.sgml,v 1.2 1998-04-06 03:58:01 hanai Exp $ -->
|
||||||
<!-- The FreeBSD Japanese Documentation Project -->
|
<!-- The FreeBSD Japanese Documentation Project -->
|
||||||
<!-- Original revision: 1.9 -->
|
<!-- Original revision: 1.10 -->
|
||||||
|
|
||||||
<html>
|
<html>
|
||||||
&header;
|
&header;
|
||||||
|
|
||||||
<h2>目標</h2>
|
<h2>概観</h2>
|
||||||
|
|
||||||
<p>Unix は幾度となく (そう言われるのも故ある事だったのですが)
|
<p>今まで触れたことのない, 複雑なオペレーティングシステムとつきあうのは,
|
||||||
覚えるのが難しいと言われてきました. ツールを基本にして
|
その OS の GUI がどんなに華やかであっても, いつだって難しい作業です.
|
||||||
コンピューティングシステムをつくる
|
そして, それは FreeBSD でも何ら異なるところはありません.</p>
|
||||||
という方法論は確かに強力ですが,
|
|
||||||
しばしばユーザは素っ気のないマニュアルによってにっちも
|
|
||||||
さっちもいかない状態へ追い込まれています. 個々のツール
|
|
||||||
に関して詳しい記述がなされてはいても, 日々の作業で
|
|
||||||
いつ, どのようにしてそのツールを使用するのか, あるいは
|
|
||||||
なぜそのツールを使用するのかを説明してある事は
|
|
||||||
ほとんどありません. ツールをどのような
|
|
||||||
状況で使用するかを説明したすばらしい本が数多く
|
|
||||||
書かれてきましたし, そのうちのいくつかは FreeBSD を使う
|
|
||||||
すべての人に強くお勧めできるものです. しかし, どの
|
|
||||||
Unix システムもおのおのクセを持っているので,
|
|
||||||
文書化されたものを全体として見ると, 実際のシステムとの
|
|
||||||
ギャップがいくつもあるものです.</p>
|
|
||||||
|
|
||||||
<p>FreeBSD ドキュメンテーションプロジェクトの目標は, まさにこの
|
<p>確かに, BSD Unix (と, もっと広範な意味での Unix)
|
||||||
ギャップを埋めることにあります. 具体的には, </p>
|
に関する書籍はたくさん存在します.
|
||||||
|
しかし, FreeBSD には FreeBSD なりの独特な機能や手続き,
|
||||||
|
クセがあります.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>それに加えて,
|
||||||
|
Unix-like なオペレーティングシステムに触れるのは FreeBSD
|
||||||
|
が初めてだというユーザもたくさん存在します.
|
||||||
|
ですから,
|
||||||
|
質の良い正確なドキュメンテーションが利用可能であることがもっとも大切なのです.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>FreeBSD ドキュメンテーションプロジェクトは,
|
||||||
|
ユーザがこの隔たりを埋めるのを助けるために存在します.
|
||||||
|
プロジェクトには二種類の作業が存在します.</p>
|
||||||
|
|
||||||
<ol>
|
<ol>
|
||||||
<li>お店で売っているふつうの Unix のユーザ, 管理者, プログラマ
|
<li><p>ドキュメンテーションプロジェクトのメンバは,
|
||||||
の手引き書には載っていない, FreeBSD に特有の機能, 手続きや
|
ドキュメンテーションを書き,
|
||||||
その他のクセを取り扱うこと. その中で最も重要になるのは次の
|
<em>FreeBSD ドキュメンテーション集</em>の一部として寄託します.
|
||||||
通り.
|
</p></li>
|
||||||
<p></p>
|
|
||||||
<ul>
|
|
||||||
<li>インストールの作業<p></p></li>
|
|
||||||
<li>サポートされるハードウェアとそのトラブルシューティング
|
|
||||||
<p></p></li>
|
|
||||||
<li>システムの設定と調整<p></p></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li>FreeBSDの一般的な話題をほぼ網羅した文書を提供すること.
|
<li><p>ドキュメンテーションプロジェクトのメンバは,
|
||||||
他の手引き書でふれられているかどうかは問題にしない.
|
<em>FreeBSD ドキュメンテーション集</em>の体裁や構成について議論し,
|
||||||
次のような話題を含む.<p></p>
|
編集を加えます.</p></li>
|
||||||
<ul>
|
|
||||||
<li>ネットワークの設定とトラブルシューティング
|
|
||||||
<p></p></li>
|
|
||||||
<li>インターネットサービスプロバイダ (ISP) への情報
|
|
||||||
<p></p></li>
|
|
||||||
<li>一般的なシステム管理<p></p></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
<h2>プロジェクト</h2>
|
<table bgcolor="#ffffcc" border="1" cellpadding="4" width="100%">
|
||||||
|
<tr>
|
||||||
|
<td><h2 align="center"><a href="../docproj/current.html">
|
||||||
|
進行中のプロジェクト</a></h2>
|
||||||
|
|
||||||
|
<p>現在, ドキュメンテーションの努力の一環として,
|
||||||
|
幾つもプロジェクトが<em>進行中です</em>.
|
||||||
|
リストに目を通して,
|
||||||
|
<b>あなた</b>にもできることがないかどうか調べてみてください.
|
||||||
|
</p></td>
|
||||||
|
|
||||||
<p>上の目標をふまえたうえで, ドキュメンテーション
|
</tr>
|
||||||
プロジェクトは二つの方向に的をしぼる事にしました.</p>
|
</table>
|
||||||
<ol>
|
|
||||||
<li><a href = "&FAQbase/FAQ.html">
|
|
||||||
FAQ</a> と, </li>
|
|
||||||
<li><a href = "handbook/handbook.html">
|
|
||||||
FreeBSD ハンドブック</a>です.</li>
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
<p><a href = "&FAQbase/FAQ.html">
|
<h2><a href="../docproj/who.html">
|
||||||
FAQ</a> の目標は, FreeBSD に関する情報を扱ういくつもの
|
我々は何者か, どうしたら参加できるのか</a></h2>
|
||||||
ニュースグループやメーリングリストでなされた, あるいは
|
|
||||||
<em>なされるであろう</em>一般的な質問を簡潔な
|
|
||||||
Q & A 形式で提供することです. 長い, こみいった回答は
|
|
||||||
この形式にそぐいません.</p>
|
|
||||||
|
|
||||||
<p>FAQ よりももっと深い議論を必要とする話題は, <a href =
|
<p>このページでは,
|
||||||
"handbook/handbook.html">FreeBSD ハンドブック</a>
|
どのような人々がドキュメンテーションプロジェクトを構成しているのか,
|
||||||
にまとめられます. 今のハンドブックはまだ何も書かれていない
|
どうやったらあなたも参加できるのか説明しています.</p>
|
||||||
章や節がたくさんあるせいで, まるで骸骨みたいです.
|
|
||||||
英知あふれる言葉で満たされるのを待っていますよ.</p>
|
|
||||||
|
|
||||||
<h2>プロジェクトに貢献する</h2>
|
<h2><a href="../docproj/doc-set.html">FreeBSD ドキュメンテーション集</a></h2>
|
||||||
|
|
||||||
<p>FreeBSD の他のプロジェクトと同じように, ドキュメンテーション
|
<p>このページでは, FreeBSD ドキュメンテーション集の構成と,
|
||||||
プロジェクトも惜しみないユーザの貢献に
|
ドキュメンテーションプロジェクトが,
|
||||||
支えられています. プロジェクトの助けとして, 文書化に関する
|
それぞれの要素に対して行っている作業について概説しています.</p>
|
||||||
問題を議論し, 製作者が情報交換するためのメーリングリストが
|
|
||||||
つくられています. 叩き台の文章を送ったり
|
|
||||||
編集に時間を割いてしもいいと
|
|
||||||
思われる方は, 次のように本文に書いたメールを
|
|
||||||
<a href="mailto:majordomo@FreeBSD.ORG">
|
|
||||||
majordomo@FreeBSD.ORG</a> まで送ってください.</p>
|
|
||||||
|
|
||||||
<blockquote>subscribe freebsd-doc</blockquote>
|
<h2><a href="../docproj/sgml.html">
|
||||||
|
SGML とドキュメンテーションプロジェクト</a></h2>
|
||||||
|
|
||||||
<p>(FreeBSD 関連のメーリングリストについて完全な情報を得たい
|
<p>プロジェクトはドキュメンテーションのために SGML
|
||||||
方は, ハンドブックの中の
|
を使用することにしています. このページでは,
|
||||||
<a href="handbook/eresources:mail.html">
|
SGML でドキュメンテーションをつくる方法を概説し,
|
||||||
メーリングリスト</a>の項を参照してください.)</p>
|
興味を持った読み手に, SGML に関する更なるリソースを教えています.</p>
|
||||||
|
|
||||||
<p>今ある文書の訂正や追加は, 新しい章を書いて送るのと
|
<h2><a href="../docproj/submitting.html">
|
||||||
同じくらい歓迎されます. それ以外のバージョンに言及する
|
ドキュメンテーションを寄託する</a></h2>
|
||||||
十分な理由がない限り, すべてのドキュメントは
|
|
||||||
FreeBSD-stable ブランチの最新リリースの状態に沿うものでなくては
|
|
||||||
なりません. そうでない場合は, その情報がどのバージョンに
|
|
||||||
関するものなのかを明記してください.</p>
|
|
||||||
|
|
||||||
<h3>訂正を送る</h3>
|
<p>ドキュメンテーションを寄託するのは,
|
||||||
|
プロジェクトに参加する最良の方法であり,
|
||||||
|
FreeBSD の使用をより簡単にする助けでもあります.
|
||||||
|
このページでは, 寄託したドキュメントがすぐに査読を受けられるような,
|
||||||
|
最良の寄託法を説明しています.</p>
|
||||||
|
|
||||||
<p>今ある文書の訂正や追加を送る時には,
|
&footer
|
||||||
FreeBSD-current に含まれる文書と訂正後の文書の差分を
|
</body>
|
||||||
<em>context diff</em> 形式で送ることが
|
|
||||||
推奨されます.
|
|
||||||
(context biff の作り方の詳細については <code><a
|
|
||||||
href="http://www.freebsd.org/cgi/man.cgi?diff(1)">diff(1)</a>
|
|
||||||
</code> のマニュアルをご覧ください).
|
|
||||||
FreeBSD-current のハンドブックは, </p>
|
|
||||||
|
|
||||||
<blockquote><a
|
|
||||||
href="ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/doc/handbook">ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/doc/handbook</a></blockquote>
|
|
||||||
|
|
||||||
<p>から, FAQは, </p>
|
|
||||||
|
|
||||||
<blockquote><a
|
|
||||||
href="ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/doc/FAQ">ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/doc/FAQ</a></blockquote>
|
|
||||||
|
|
||||||
<p>から手に入ります. 差分は <a
|
|
||||||
href="mailto:freebsd-doc@FreeBSD.ORG">freebsd-doc@FreeBSD.ORG</a>
|
|
||||||
へ送ってください. 内容が検討されます.</p>
|
|
||||||
|
|
||||||
<h3>新しい叩き台を送る</h3>
|
|
||||||
|
|
||||||
<p>他の FreeBSD ユーザにとっても興味深い話題の専門知識に
|
|
||||||
自信があって, しかもその話題が FAQ にもハンドブックにも
|
|
||||||
載っていない場合, あなたの知恵をどちらかに取り入れるのに
|
|
||||||
やぶさかではありません. 叩き台を送りたいけれども何が
|
|
||||||
必要とされているのかわからないという方は,
|
|
||||||
<a href="handbook/handbook.html">ハンドブック</a>と
|
|
||||||
<a href="&FAQbase/FAQ.html">FAQ</a> を眺めて,
|
|
||||||
<em>あなたが</em>何か見落としていないか
|
|
||||||
よく確かめてみてください. 特に, ハンドブックには
|
|
||||||
非常によくできた目次がついていますが, アスタリスク (*)
|
|
||||||
のついたセクションは今のところ何も書かれていなくて,
|
|
||||||
熱意ある書き手を待っている状態です.</p>
|
|
||||||
|
|
||||||
<p>今のところ, 新しい叩き台を送る時には, Docbook DTD に
|
|
||||||
則した SGML 形式が推奨されています. 現在, Linuxdoc DTD から
|
|
||||||
Docbook へ形式を移行している真っ只中なので, ソースとなる
|
|
||||||
文書をどうやって別の形式に改めるかについては, 今の時点では
|
|
||||||
はっきりとは定まっていません.
|
|
||||||
この問題に関するアナウンスは freebsd-doc <a
|
|
||||||
href="handbook/eresources:mail.html">メーリングリスト</a>
|
|
||||||
の中で行われます.
|
|
||||||
<a href="http://fallout.campusview.indiana.edu/~jfieber/docbook">
|
|
||||||
Docbook に関する文書とリソース</a>のページはこちら. もっとよく
|
|
||||||
知りたいという方はどうぞ.</p>
|
|
||||||
|
|
||||||
<p>SGML があまり好きでない方は, LaTeX 形式で送ってもらっても
|
|
||||||
かまいません. ほとんど何の苦も無く SGML に変換できるからです.
|
|
||||||
それもだめだという場合には, ただのテキスト形式で送って
|
|
||||||
もらえれば十分です.</p>
|
|
||||||
|
|
||||||
<p>編集に関する一般的なガイドラインをいくつか述べておきます.</p>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li>短縮形 (can't, I'm などの形式) を使わないでください.
|
|
||||||
<p></p></li>
|
|
||||||
|
|
||||||
<li>具体的な例をあげてください.<p></p></li>
|
|
||||||
|
|
||||||
<li>相互に参照しあいましょう. HTML版の文書では,
|
|
||||||
ハイパーテキストのリンクを使用することができます.
|
|
||||||
<p></p></li>
|
|
||||||
|
|
||||||
<li>同じ文書の他のセクションで述べられているのと重複する
|
|
||||||
ことを書いてはいけません. そうした方が良いと思われても
|
|
||||||
です. もしあるセクションに今載っている情報があなたの
|
|
||||||
担当している話題を助けるのに十分でないように思われたなら,
|
|
||||||
更なる情報があなたの書いているセクションにあった方が
|
|
||||||
よいか, 参照先のセクションに追加された方がよいかを考えて
|
|
||||||
みてください. もし後者だと思われたなら, 参照先の
|
|
||||||
セクションの担当者と話し合ってみてください.
|
|
||||||
<p></p></li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
&footer
|
|
||||||
</body>
|
|
||||||
</html>
|
</html>
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue