POPFileのドキュメントをよりよくするためにできることはありますか?

POPFileのドキュメントは POPFile: POPFile ドキュメンテーションプロジェクト に移っています。

Wiki によって、誰でもドキュメントの編集に貢献することができ、継続的にドキュメントを改善することができるようになっています。ドキュメントの改善のために、あなたの知識を遠慮なく追加してください。アカウントのサインアップは、 こちらです。

編集する際のヒントもあります。

ドキュメントの日本語化プロジェクトについて

POPFile 日本語化プロジェクトでは、このドキュメントの翻訳をすすめ、ほぼすべてのページの翻訳を終えることができました。たくさんの方のご協力ありがとうございました。今後は、既存ドキュメントの更新時への対応などが主となりますが、ドキュメンテーションプロジェクトに興味のある方は、以下を参照してください。

プロジェクトに参加するまでの流れ

  1. まず、SourceForge.jp にユーザ登録を行います。
  2. popfile-jp-doc メーリングリスト に登録し、メーリングリスト宛に簡単な自己紹介などを投稿してください。
  3. こちら からサインアップを行ってください。

編集(翻訳)する際のルールについて

日本語プロジェクトでは、ページの内容に統一性を持たせるため、いくつかのルールを定めています。編集する際には、以下のルールに従って行うよう心がけてください。

  1. 日本語ページは、必ず「jp」ネームスペース内に作成してください。このドキュメントのように、原文が「faq:dochelp」であれば、これに「jp」を追加した「jp:faq:dochelp」が日本語ページとなります。既存のページを編集する場合には気にする必要はありませんが、新しいページを作成する際にはご注意ください。
  2. 翻訳ページの下に必ず原文へのリンクを設定してください。これにより、レビューを行う方が原文を簡単に参照できるようになり、また、翻訳文が更新されていない場合でも原文を読んでいただくことが可能となります。
  3. ページの最後にはPOPFile ドキュメンテーションプロジェクトへのリンクを設定してください。これによっていつでもトップページに戻ることができるようになります。また、トップページからいくつかの階層がある場合は、それぞれの階層に戻るためのリンクをできるだけ作成するようにしてください。
  4. 日本語オリジナルのドキュメントを作成した場合には、できるだけ英語に翻訳したページを作成するように心がけてください。日本語環境にのみ関係するドキュメントについてはこの限りではありません。

編集(翻訳)の手順について

日本語版 POPFile ドキュメンテーションプロジェクトでは、翻訳→レビューという流れを基本としています。これは誤訳を避けるとともに、できるだけわかりやすい文章にするためにも効果的だと考えています。逆に言えば、レビューという仕組みがあるわけですから、あまり自信がなくてもどんどん訳してもらえるとうれしいです。

新しいページを翻訳するとき、あるいは既存のページでも大きな修正があった場合については翻訳後、レビューに回していただきますようよろしくお願いします(修正内容が大きいかどうかの判断は翻訳された方にお任せします)。編集する際の大まかな手順は以下のとおりです。

  1. 新しいページ(あるいは既存のページ)の翻訳をします。
  2. 日本語版 POPFile ドキュメンテーションプロジェクトに貢献した人たち の該当するレビュー待ち文書欄に、翻訳したページへのリンクを設定し(翻訳された方のアカウント名もしくは名前、そのページが新しいページなのか更新されたページなのかがわかるようにお願いします)、popfile-jp-doc メーリングリストにレビュー依頼を行います。
  3. レビューする方は、該当ページのレビューを行い、修正する箇所があれば修正し、 日本語版 POPFile ドキュメンテーションプロジェクトに貢献した人たち の該当するレビュー待ち文書欄からリンクを削除し、メーリングリストにレビュー完了報告を行います。その際、レビューの際に気になった点や大きな修正点があればそれも報告をお願いします。

翻訳以外の作業について

お使いのメールクライアントで POPFile を使用する方法、ファイアウォール、ウイルス対策ソフトと POPFile を共存させる方法を書いていただけるかたを募集しています。できるだけ多くのソフトウェアについて使用方法を掲載したいと考えていますが、実際に使っている方でないとわからないところもあるため、多くの方の協力が必要です。

お使いのソフトウェアについての設定方法を書いていただけるという方は、ハウツーの「特定のメールクライアントの設定」や「プロキシとファイアウォールソフトの設定」に項目の追加をお願いします。

特定のソフトウェアについての設定方法については、同じソフトウェアを使用している方でないと内容の検証が行えませんので、レビューの対象外とします。ですが、情報はできるだけ共有していきたいと考えていますので、新しいページを作成された方は、メーリングリストへご報告いただければと思います。

日本語プロジェクトに貢献した人たち

POPFile はオープンソースプロジェクトですから、翻訳していただいた方に見返りを提供することはほとんどできません。ですが、ささやかではありますが、以下のページにクレジットを残しています。多くの方のご協力のおかげでドキュメントはほぼ完成しましたので、今後はこのページを翻訳、レビューの分担表として活用していきたいと思っています。

日本語プロジェクトへのご意見は

プロジェクトには参加しなくても、このドキュメンテーションプロジェクトに関して質問・提案・要望などがありましたら、popfile-jp-doc メーリングリストまたは POPFile 全般フォーラムへどうぞ。

参考:

原文

FAQ 初学者向けの Q&A 集

POPFile ドキュメンテーションプロジェクト

 
jp/faq/dochelp.txt · Last modified: 2008/02/08 19:49 (external edit)

Should you find anything in the documentation that is incomplete, unclear, outdated or just plain wrong, please let us know and leave a note in the Documentation Forum.

Recent changes RSS feed Donate Driven by DokuWiki
The content of this wiki is protected by the GNU Fee Documentation License