このリポジトリはPHP Webアプリフレームワーク、Laravel Jetstreamの公式英文ドキュメントを日本語へ翻訳しています。
This is a Japanese translation repository for Laravel Jetstream official documentations.
注意：Laravel開発者のTaylor Otwell氏は、英語のネイティプスピーカーです。英語しか理解できません。 自分の理解できないものには責任が持てないと言う理由から、 公式ドキュメントは英語のみです。そのため、日本語翻訳を「公式」と呼ばないでください。 「日本語ドキュメント」、「和訳翻訳ドキュメント」など適切にお呼びください。
- 誤訳やタイポ、未翻訳部分などを報告する場合、以下の内容を含めてください。
- ページ（章）：GitHubのリポジトリやreadouble.comのURL、もしくはページのタイトル（「イントロダクション」、「Livewire」）など。ページの特定が容易であれば形式はかまいません。（報告に手間がかかるので、行番号を含めたリンクをわざわざ張る必要はありません。）
- 問題のある和文、および正しいと思われる和文（エディターで検索して該当箇所を見つけます。）
- 専門用語（訳語）の不統一に関しては、プロジェクト全体を検索しますので、特定のページを指定する必要はありません。それ以外の表記揺れに関しては、該当ページがわかるようにしてください。（表現上の揺れなどは、一度に変更できません。少しづつ、気がついた時点で修正します。）
- 日本語ドキュメントを利用するのは日本人です。そのため、報告やコメントは日本語で記述してください。
- このリポジトリではJetstream翻訳和文のみ管理しています。readouble.comで公開している他のバージョンの和文に関しては、@HiroKwsにツイートいただくか、[email protected]へご連絡ください。
Issueで報告していただくのが、一番簡単です。
https://github.com/laravel-ja/ja-doc-jetstream/issuesのページで、"New issue"ボタンをクリックし、issueを発行してご報告ください。
- translation-jaディレクトリ下の日本語翻訳Markdownファイルのみを変更してください。それ以外のファイルは変更しないでください。
- 翻訳対象となるバージョンの原文は、original-enディレクトリ下にあります。Laravelのドキュメントリポの最新版ではないことに注意してください。
- ディレクトリ／ファイル構造を変更しないでください。
- 原文と翻訳の文章構造は一致させてください。原文と翻訳は、空行・タイトル行など行ごとの構造を同一に保っています。これにより、翻訳が原文のどの箇所であるかを簡単に見つけることができます。また、原文の変更を翻訳へ反映させる処理を自動化するにも役立てています。
- 原文／翻訳間のファイル構成の一致のチェック、原文／翻訳間の各ファイルの行構成の一致のチェック、用語の不一致のチェックを行うスクリプトが、scripts/pre-commitです。可能であればこれをコミット前に実行し、確認してください。実行にはgawk、awk、sed、bashなどが必要です。
- pre-commitは、プルリクエスト時にCIでも実行されています。エラーになるものはマージしません。
現在翻訳中です。翻訳中にIssueを処理するのは煩雑な作業になり、翻訳スピードが落ちてしまいます。一通り翻訳を完了するまで報告はご遠慮下さい。
| ディレクトリ／ファイル | 内容 |
|---|---|
| original-en | 翻訳対象原文ブランチの内容 |
| translation-ja | 日本語翻訳Markdownファイル |
| scripts | 用語統一、文章構造確認などの補助スクリプト |
| タグ形式 | 内容 |
|---|---|
| published.YYMMDD.HHMM | readouble.comへ公開したコミット |
published.YYMMDD.HHMM形式のタグは、readouble.comなどで翻訳文を読む利用者向けのタグです。この形式のタグ間でdiffを確認してもらうことで、前回のリリース時の原文／翻訳文と次回の変更点／差分を確認できます。
現在、Jetstreamのアップデート期間などはまだ不明ですので、後ほど検討します。
日本語翻訳の構造は英語と一致させています。行数も変更していません。これにより、原文の変更点の和文への適用などを自動化しています。また、行で対応させることにより、日本語訳に対する英文を見つけ出しやすくしています。
重大な原文の間違いがない限り、和文に情報を付け加えません。LaravelメンテナのTaylor Otwell氏は、「ドキュメントに何もかも詰め込んでしまうと、メンテしづらく、読み手にも負担になる」という方針です。その方針を基準に現在の情報量となっています。それを尊重しています。
以前は日本語訳にいろいろと注釈を付け加えていましたが、長期間のメンテナンスでは管理が負担になります。作業をシンプルに保たないと長期間のメンテナンスは困難です。その理由でも、原則注釈は付け加えていません。
日本語訳に足りない部分は、原文に足りない部分です。公式ドキュメントに足りない部分を追加するPRを行うか、もしくはブログ記事などを書き、内容を補ってください。また、原文の間違っている箇所、わかりづらい箇所に付きましては、原文のリポジトリへの報告や修正依頼をお願いします。
翻訳が必要なのは、英語が苦手な方です。「英語を読むことが苦手な技術者」をターゲットとして翻訳しています。そのため、訳語が日本のコミュニティで定まった用語は、それを尊重しています。英単語が技術用語として定着している言葉は、日本語読みを採用しています。（リクエスト、イベントなど）また、まだ適切な用語が存在しない部分についても、米語発音を基本に訳語として採用しています。
初学者に対して読みやすくすることは、学習を終えたレベルの技術者にとって冗長になります。そのため、初心者に優しくするよりは、ある程度のレベルの技術者であれば親しんでいる、もしくは調べれば意味の取れる専門用語レベルを選んでいます。
専門的（コンピューター／数学分野／ソフト開発業界用語）な用語に訳しています。理由は英文のままでは苦手な方にとって意味が分かりませんが、和文であれば必要に応じて意味を調べられるからです。
訳出の変更などのissueは、「英語を読むのが苦手な技術者」の視点で検討してください。issueを発行してくださる方は、英語を読める方が多く、翻訳を公式ドキュメントの補助として利用している方も多いでしょう。私自身もそう利用していますが、原則は補助として利用する目的でなく、英語の公式ドキュメントを読解するのが困難な技術者の手助けにしていただくのが方針です。
原文と当翻訳のライセンスはMITです。Copyrightは存在しています。そのため、参照する場合は参照元を記述するか、リンクを張る必要があります。
原文と当翻訳は別のCopyrightです。そのため、原文と当日本語訳を参照する場合は、それぞれの参照元を示す必要があります。
技術者としての知識とコンプライアンス精神を表すために、他のMITライセンスのプロジェクトからドキュメントなど一部を記事などから参照し、公開する場合もきちんと参照元を示しましょう。忘れがちですが動画、ポッドキャストでも同様です。