6. モノ書き・翻訳編

Web の コンテンツやマニュアル・HOWTO を書いていただきます。 順序としては、まず日本語のドキュメントを書いて、 その旨 members-ML で連絡し、翻訳担当者に翻訳していただく形になります。

ドキュメントの書き方の手順については Document-HOWTO をご覧ください。

6.1. グループと権限

モノ書きさん・翻訳担当さんは以下のようになります。

グループ 権限
www www レポジトリの checkout・commit が可能

これとは別に、weboperator グループが存在します。 これは、www コンテンツの正常な更新を確認する必要性から、httpd の再起動権限を持つグループです。 (see : 8.1.「グループと権限」)

なお、docs レポジトリは、momonga グループに属していれば誰でも checkout・commit 可能です。 ですから、Momonga Project のアカウントを持っていれば、無条件で checkout・commit 可能となります。

6.2. コンテンツの更新について

コンテンツを更新した場合は、手元で

    $ xmllint --noout --valid Hoge-HOWTO.xml
    $ make
   

などを実行し、エラーや警告が出ない事を確認してから commit してください。 生成されたHTMLファイルやテキストファイルももう一度読んでみましょう。

コンテンツは cron により毎正時ごろに更新されます。 ドキュメントを変更して commit したのに反映されない時は、 akane に slogin して /home/momonga/html/docs/home/momonga/html以下で、

    $ sudo -u momonga svn update
    $ sudo -u momonga make
   

などを実行しどのようなエラーが出ているか確認してみましょう。

6.3. HOWTO ってどんなものを書けばいいの?

貴方が動作させるのに苦労したモノは、他の方も苦労してるかも知れません。 そういう時 HOWTO があれば心強く感じるものだと思います。 貴方の苦労を形にしてみてください。

6.4. 注意しておきたいこと

  • ひとつのドキュメント内では、文体や句読点の種類を統一してください

  • 漢字で書ける部分は漢字を使いましょう:)

  • 修正や更新が必要な部分があれば、速やかなアップデートを心がけてください

  • 画像に GIF は使わないで PNG を使うようにしてください