GentooJP オリジナルドキュメントプロジェクト

1.GentooJP オリジナルドキュメントプロジェクトにようこそ!!

GentooJP オリジナルドキュメントプロジェクトは、Gentoo Linux Project には無いドキュメントを作成したり、作成の支援をするプロジェクトです。

このドキュメントにはオリジナルドキュメントを書くときの注意、投稿の流れが書いてあります。

オリジナルドキュメントプロジェクトとは、 Gentoo に関する日本語のドキュメントを募集して、それを発表していこう、というものです。GentooJP は発表の場所を提供するだけです。ドキュメントの保守などは各著者の方にお任せします。

オリジナルドキュメントプロジェクトは、Gentoo Linuxを使っていく上でのヒント、 チュートリアル、みんなに自慢したい使い方、ちょっと賢い設定方法、 Gentoo Linux Projectや翻訳ドキュメントには書かれていないこと、 そんなドキュメントを募集しています。

2.ドキュメントの投稿方法

ドキュメントの投稿は簡単です。Gentoo Linux Project/GentooJPで仕様しているxml形式でドキュメントを書いて送ってくれるだけでOKです。 詳しい流れは下記のようになります。

ドキュメントを書く 

初めに書いたように、オリジナルドキュメントの内容にはあまり制約を持たせません。 ただし、過度に商業的なもの、誹謗、中傷の類い、性的な内容、など一般常識的に不適格なものは当然ダメです。誰かが幸せになれるドキュメントにしてください。 また、ドキュメントは xml 形式で書いてください。xmlの書き方、構成については、次の章で簡単に触れます。

ドキュメント用メーリングリストに入る 

そして、ドキュメント用のメーリングリスト(gentoojp-docs)に入ってください。この ML がドキュメントの受付け窓口になります。

ドキュメントを投稿する 

できあがったドキュメントを gentoojp-docsメーリングリストに投稿してください。オリジナルドキュメントの内容については、著者の責任とします。 このため、翻訳と違い、文章的な査読（誤字や言い回しなどのチェック）はありますが、内容に関する査読（技術的な検証等）はありません。 もし、内容に関する査読希望の場合は「査読希望」という旨のメッセージも付けてください。

ドキュメント掲載 

投稿されたドキュメントは GentooJP のオリジナルドキュメントのリストに加 えられます。

ドキュメントのメンテナンス 

内容が古くなってしまったり、変更が必要なドキュメントについては、 メンテナンス(更新作業)が必要になります。 メンテナンスするかどうかについては、著者の判断でお願いします。 また、もしかしたら、ドキュメント管理メンバーからメンテナンスのお願いがあるかもしれません。

更新する場合には、新規登録時と同じようにgentoojp-docsメーリングリストに投稿してください。

ちょっと細かいけど大事なこと 

オリジナルドキュメントのプロジェクトに参加するのは簡単ですが、いく つか御理解いただきたい点があります。

• 著作権について -- 完全にドキュメントの著者の方に帰属します。
• でも、ページの下の方に Copyright 云々とでてますけど? -- 早くなおします。
• 匿名投稿について -- まったくの匿名はご遠慮ねがいます。 ハンドルネームはOKです。
• メールアドレスについて -- かならず連絡がとれるメールアドレスをmail タグに指定してください。
• 管理者は内容を変更するの? -- 原則内容の変更しませんが、 タグ属性を変更するといったシステム側の変更は、著者に連絡なしに行うことがあります。

3.ドキュメントの書き方

オリジナルドキュメントも他のドキュメントや翻訳と同じように xml で記 述します。xml といっても約束事は最低限のものしかありません。次のサンプ ル書式を参考にしてください。

//エンコードは必ず UTF-8 を使用してください。
<xml version='1.0' encoding='UTF-8'?>
<?xml-stylesheet href="/xsl/guide.xsl" type="text/xsl"?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">

<guide link="/contribution/**オリジナルドキュメントのファイル名**">
//たとえば、hoge.html ならば、<guide link="/contribution/hoge.html"> としてください。

<title>GentooJP オリジナルドキュメントプロジェクト</title>
<author title="Author">
<mail link="[email protected]">真藤直観</mail>
</author>
//author タグの title 属性は"Author"を指定してください。
//また、メールアドレスは必ず記載してください。

<abstract>
GentooJP でのオリジナルドキュメントに関する説明です。
</abstract>
<version>0.1</version>
<date>27 Oct 2003</date>
//title, author, abstract, version, date タグは必ず入れてください。

<chapter>
<title>chapter のタイトル</title>
<section>
...本文...
</section>
</chapter>

</guide>

ドキュメントの作成については、オリジナルドキュメントにある「翻訳とオリジナルドキュメント作成環境の構築ガイドや Gentoo Linux XMLガイド も参考にしてください。 特に「翻訳とオリジナルドキュメント作成環境ガイド」には AxKit での環境構築方法が載っており、 ドキュメントを書くときには非常に役に立ちます。