Table of Contents
翻訳の過程で蓄積されていくテクニックや予めルール／方針を統一しておいた方が手間がかからなくて皆が幸せになるような事項を以下にまとめる。
Translation Flow
This slide show a draft.
...
Project Management
We use GitHub issues, projects, and milestone for project management.githubにファイル/フォルダごとのissueを設定しますので、issueのコメント欄に翻訳着手する旨の申告をお願いいたします。githubのマイルストーンで全体の進捗管理をする予定です。
Githubのissueで翻訳する旨のコメントをお願いいたします。もし、翻訳着手されていないissueがあれば、そちらを担当いただいてもOKです。
issueには、下記の内容を含めて設定ください。例：https://github.com/hyperledger/fabric-docs-i18n/issues/116
- タイトル：翻訳するドキュメントの階層
- 詳細：readthedocの該当ページと翻訳ファイルのURL
- Assignees：翻訳する方のアカウント
- Labels：jaJP-docs-ongoing
- Projects：ja-JP
既存のissueに関しては、Assigneesが未設定、かつ、コメント欄で誰も担当することを宣言していない、場合には翻訳未着手とみなすこととします。
翻訳未着手のissueを担当したい場合には、そのissueのコメントにて自分が担当する旨記載してください
(※Assigneesの設定はmaintainerしか設定できないためOptionalとします)。
Githubのマイルストーンは今後必要に応じて設定します。
また、翻訳着手されましたら、下記のプロジェクトページのカードを"In progress"に移してください。
https://github.com/hyperledger/fabric-docs-i18n/projects/1
翻訳範囲
| 概要 | 種別 | 説明 | 例(File/Issue/Pull Request) | 備考 | Status (Draft/Approved) |
|---|---|---|---|---|---|
| ヘッダは訳さなくてもよい | md | ページ内に目次を置く場合、アンカーの都合上、英語のままの方が手間がかからない。 和訳した各ヘッダーにリンク張るためには少しトリッキーな方法が必要だった。 | international_languages.md | ※特に決定事項というわけでもなさそうなので後ほどでご意見お聞かせください（チャットもしくはミーティングで）
| Approved(2020/08/18) |
| ヘッダは訳さなくてもよい | rst | 特にトリッキーなことをせずに日本語に変換できる場合は、分かりやすさを優先して翻訳する | Approved(2020/08/18) | ||
| 共通 | |||||
| rst |
日本語文章統一ルール
表記ゆれを防ぐために本WGが定める基本的な日本語文章のルールです。
| 概要 | 備考 | Status (Draft/Approved) |
|---|---|---|
| 語尾は「である」調ではなく「ですます」調を使う | Approved | |
| 句読点は「，」「．」ではなく「、」「。」を使う | Approved |
Issue/Pull Request発行
| 概要 | 説明 | 例(File/Issue/Pull Request) | Status (Draft/Approved) |
|---|---|---|---|
コミットメッセージおよびPRのタイトルは“[ja_JP]” で始める | ログや一覧で見分けやすいように | [ja_JP] translate glossary.rst into Japanese · hyperledger/fabric-docs-i18n@127a41d | Approved(2020/08/18) |
| Issue/PRのタイトルはファイル名よりもドキュメントの階層を明記する | その方が実際のドキュメント構成とのマッピングがしやすく抜け漏れの確認も楽になる | Key Concepts >> Fabric chaincode lifecycle Draft | Approved(2020/09/01) |
PR投稿前のセルフチェックリスト
| 概要 | 説明 | 備考 | Status (Draft/Approved) |
|---|---|---|---|
| Translation Rulesに従っているか | 本ページのセクション全体を確認してください。 | Approved(2020/08/18) | |
| Hyperledger Fabric固有の単語に関して用語集に従っているか | https://github.com/linuxfoundation-jp/HL_Fabric_Doc-Jp | Approved(2020/08/18) | |
ドキュメントビルド時(make html)に、 追加のWARNINGメッセージが出ていないことを確認する | 自身の編集作業によって新たに発生したWARNINGはできる限り無くなるように対応してください。 - WARNINGを確認することで、特にrstファイルについて、デッドリンク含めたフォーマットミスはある程度気付くことができます。 - 些細なものもありますが全体数を増やさないことが、他のコントリビュータが自身の追加したWARNINGに気付くのを助け、全体の品質維持につながります。 ※注意事項: 数件のWARNINGは本家から引き継いで発生していますので（後述のWARNING一覧参照）、これらは無視してください。 | Approved(2020/08/18) | |
ビルド後に、自身が翻訳したページについてブラウザ等で参照し、 フォーマット崩れがないことを一通り確認する |
| Approved(2020/08/18) | |
1ファイルの翻訳につき1 commitとなっていること | レビューを受けて修正した場合でも、原則的にcommitは1つにまとめる。複数ファイルを翻訳した場合には、ファイルごとに別commitとする。 ただし、同様の修正を複数のファイルにわたって行う場合 (アンカーの修正など) などはこの限りでない。 | Approved(2020/08/18) |
本家から引き継いでいるWARNING一覧
release-2.2においては、本家から引き継いで以下のchecking consistency WARNINGが発生しています（2020年8月13日時点）。これらはどこからもリンクが張られていないために発生している警告となります。
...
- source/build_network.rst: WARNING: document isn't included in any toctree
- source/developapps/apis.md: WARNING: document isn't included in any toctree
- source/github/github.rst: WARNING: document isn't included in any toctree
- source/ledger.rst: WARNING: document isn't included in any toctree
- source/msp-identity-validity-rules.rst: WARNING: document isn't included in any toctree
- source/policies.rst: WARNING: document isn't included in any toctree
- source/security_model.rst: WARNING: document isn't included in any toctree
- source/tutorial/installxcode.md: WARNING: document isn't included in any toctree
最新の本家ドキュメントパッチの取り込み方法
本家最新ドキュメントとの更新差分を翻訳プロジェクトのほうに取り込む方法とその運用ポリシーは以下のとおりとする。
取り込み方法
- 本家(release-2.2ブランチ)のドキュメント更新パッチ1件ごとにそのパッチを適応した翻訳パッチも1件とする。
- 未翻訳の新しいファイルの場合には良い機会なので翻訳も実施する。
- コミットメッセージには、下記フォーマットに従って、取り込んだ本家ドキュメント更新コミットのコミット番号を必ず記載すること。
本家ドキュメント更新を取り込んだパッチのコミットメッセージのフォーマット
-------------------------
[ja_JP] Sync with release-2.2 (translated)
commit: 9a6b35104e88dc2df08db7c7b0ba3d0f61127a85
-------------------------
本家ドキュメント更新のウォッチ方法や取り込みタイミング
- 基本的には、マイナーリリースのタイミングでチェックして実行する。
- ただし、個々人でやりたい人は都度対応してもよい。
- 上記での抜け漏れやその対応状況も確認するために、取り込みパッチにはフォーマットに従って本家のコミット番号を必ず付与すること。
Translation tools
みんなの自動翻訳 TexTra（このツールの使用は必須ではありません。）
...
https://github.com/linuxfoundation-jp/HL_Fabric_Doc-Jp
翻訳・対訳集 サブグループ
Scope: 目的
1. Hyperledger Fabricの英語ドキュメントを日本語へ翻訳する際に使用する専門用語や表現の共有
2. translator/reviewerのサポート
3. TexTraとの連携
Members
| Emi Maekawa |
| Satomi Tsujita |
| Taku Shimosawa |
| Tatsuya Sato |
| Yuki Kondo |