翻訳作業の方針 (暫定)

[cognitom]

固まってきたら、WikiかCONTRIBUTING.mdあたりに移動する前提で、ここに方針を書きとめていきます。ツッコミと情報あれば、コメントに書いてください。

初回のみ必要な作業

1. 本家のドキュメントリポジトリからフォーク
2. リポジトリ名を「プロジェクト名-言語 」に変更

個別ページの翻訳

作業はGitHubでプルリクエストベースで進めます。原文との対応をわかりやすくするため、togglateで原文をコメントアウトして文書中に残します。

ツールの準備

1. GitとGitHubが使える環境: GUIであれば、GitHubかSourceTreeなど
2. togglate

Togglateのインストール

$ sudo gem install togglate

翻訳の下準備

原文をtogglateで、段落ごとにコメントアウトします。togglateには元ファイル自体を書き換えるモードがないので、一旦別ファイルに書き出してから移動で上書き。

$ togglate create -e=false -c path_to/file.md > temp.md
$ mv -f temp.md path_to/file.md

• -e=false: JavaScriptを付加しない
• -c: コードブロックをコメントアウトしない
• -t=to:ja: 自動翻訳 ※ただし、今のところエラーになるようなので使用せず (要調査)

ASCII以外の文字が含まれるとエラーになるようです。その場合、CotEditorなどでUTF-8からASCIIに文字コードを変換して、非アスキー文字を別の文字にしてから、もう一度UTF-8に戻すと回避できました。

先にプルリクエスト

翻訳作業に入る前に、WIP(=Work in Progress)としてプルリクエストを作成します。この時点では、一切翻訳していなくてもtogglateだけしてあればOKです。

• ブランチ名: 作業するファイル名 ex. Whats-Rocketeer
• プルリクエストのタイトル: [WIP] + 章の日本語タイトル ex. [WIP] Rocketeerとは

翻訳

• わかりにくい表現になるよりは、意訳でOK
• 段落の対応付けは正確に
• 訳語はなるべく統一 (翻訳辞書も追い追い整備すること)
• 作業の途中でも、一区切りついたらコミット & プッシュ

翻訳完了

1. 他のメンバーにレビューしてもらう
2. 問題なければプルリクエストのタイトルから[WIP]を外す
3. masterブランチにマージ
4. バージョンタグを付加

ドキュメントサイトの公開

(方法を検討中)

本家のドキュメントに更新があった場合

(方法を検討中)