Table of Contents
翻訳の過程で蓄積されていくテクニックや予めルール／方針を統一しておいた方が手間がかからなくて皆が幸せになるような事項を以下にまとめる。
Translation Flow
This slide show a draft.
...
- タイトル：翻訳するドキュメントの階層
- 詳細：readthedocの該当ページと翻訳ファイルのURL
- Assignees：翻訳する方のアカウント
- Labels：jaJP-docs-ongoing
- Projects：ja-JP
既存のissueに関しては、Assigneesが未設定、かつ、コメント欄で誰も担当することを宣言していない、場合には翻訳未着手とみなすこととします。
翻訳未着手のissueを担当したい場合には、そのissueのコメントにて自分が担当する旨記載してください
(※Assigneesの設定はmaintainerしか設定できないためOptionalとします)。
Githubのマイルストーンは今後必要に応じて設定します。
...
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 | Approved(2020/09/01) |
...
- 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件とする。
- 未翻訳の新しいファイルの場合には良い機会なので翻訳も実施する。
- コミットメッセージには、下記フォーマットに従って、取り込んだ本家ドキュメント更新コミットのコミット番号を必ず記載すること。
本家ドキュメント更新を取り込んだパッチのコミットメッセージのフォーマット
...