ドキュメント作成ガイドライン

日本語訳、および独自の日本語コンテンツのためのガイドラインについて説明します。わからない箇所はメーリングリストに遠慮なく相談してください。

ドキュメント作成時の基本ルール

細かいルールは決めていませんが「Sun の日本語翻訳ガイドライン」は一読しておくことをおすすめします。
わかりやすい日本語を書くという意味で非常に参考になります。

• 「です・ます」調で統一します
• 日本語と英語の間には見やすくするように空白を入れます

• UI メッセージはわかりやすくするように「」をつけます

• 用語は基本的に用語集にしたがいます
• 用語集にない用語は SunGloss などを参考できます
• 新規の用語についてはチームメンバーに相談してください

• UTF-8 エンコーディングを使用します。ただし UTF-8 を使うのが難しい場合には相談してください
• スタイルシートは netbeans.org のものを使います。

	<link rel="stylesheet" type="text/css" HREF="http://www.netbeans.org/netbeans.css">

• スクリーンショットを載せる場合には PNG 形式で、またフォントや色、テーマなどはできるだけプラットフォームでデフォルトのものを使いましょう
• イメージファイルはその HTML ファイルと同じ名前でディレクトリ作りその中に置いてください
例: gettersetter.html がファイル名だとすると gettersetter/ フォルダにイメージファイルを置きます。相対位置でイメージファイルを参照してください。

翻訳時の基本ルール

翻訳に関しても細かいルールは決めていませんが、基本的には以下のルールに従ってください。

• 翻訳したいページがあればまずすでに翻訳されているかどうか確認します。右上の言語選択メニューで日本語があるかどうか確認します

• 翻訳対象のファイルとイメージファイルなどを取得します。これはメーリングリストでお願いしてください

• できるだけ原文に忠実に訳してください
• タグを変更しない
• 構成を変えない
• 英語を削除して訳さない、付け足さない

• 翻訳ファイルは _ja.html にします

• イメージファイルも同様にファイル名を変更します

<img src="../images/tutorials/quickstart/initial-projects-window_ja.png">

http://platform.netbeans.org/images/tutorials/quickstart/initial-projects-window.png (英語)
http://platform.netbeans.org/images/tutorials/quickstart/initial-projects-window_ja.png (日本語)

参考

• 既存の日本語ドキュメント

• ja.OpenOffice.org 作業の流れ

• Sun の日本語翻訳ガイドライン

• Sun のスタイルガイド

• 用語集 SunGloss

• 用語集: NetBeans 5.0 の UI 用語集