Next.js のドキュメントを日本語へ翻訳するためのスタイルガイドです。翻訳開始前に必ず読んでください。
もし、わからないことや質問等がある場合はSlackの#questions チャンネルで質問してください。
翻訳スタイルガイドの改訂案がある場合は、issues を立てるか、プルリクエストを送ってください。
敬体（ですます調）を使って翻訳してください。
敬体の参考記事:
ですます？である？文章の〈敬体〉と〈常体〉の使い分けを考える
半角と全角が切り替わる箇所にスペースをいれてください。また、(``)や("")で囲まれている場合は、textlint で検知でないので、手動でスペースをいれてください。
ここでは、Markdown として見たとき（= 編集時点）の半角 / 全角の切り替わりを基準とするのではなく、HTML になったとき（= ドキュメントとして完成した時点）の半角 / 全角の切り替わり部分の有無を基準としてください。
例外として、約物（特に句読点 。, 、）と直接隣接している場合は英単語と和文の間のスペースはいれないでください。
良い例:
スタイルシートをアプリケーションへ追加するために、`pages/_app.js`␣内で␣CSS␣ファイルをインポートしてみましょう。
パッケージを**活用**することで␣API␣エンドポイントに␣[CORS␣設定](https://developer.mozilla.org/ja/docs/Web/HTTP/CORS)をできます。
悪い例:
スタイルシートをアプリケーションへ追加するために、`pages/_app.js`内でCSSファイルをインポートしてみましょう。
パッケージを␣**活用**␣することで␣API␣エンドポイントに␣[CORS␣設定␣](https://developer.mozilla.org/ja/docs/Web/HTTP/CORS)␣をできます。
もし、スペースを入れる場所が分からない場合は、textlint のルールに沿ってください。
text-lint:fixという、textlint のルールに修正するコマンドも用意されています。翻訳対象のファイルを指定して実行してください。
ここでは、例として example.md を指定してます。
$ yarn text-lint:fix ./docs/example.md
コードブロックのコメントも翻訳してください。コードブロック内にコードを追加したり、独自のコメントを入れないでください。
良い例:
npx create-next-app
# または
yarn create next-app
悪い例:
// Reactを作成するコマンド
npx create-next-app
# or
yarn create next-app
内部リンクがある場合は、別のページにリンクする文章は翻訳しても構いません。しかし URL は変えないでください。
良い例:
詳細は、[デプロイメントのドキュメント](/docs/deployment.md)をご覧ください。
悪い例:
詳細は、[デプロイメントのドキュメント](/docs/デプロイメント.md)をご覧ください。
もし外部リンクに十分なクオリティーの日本語版サイトがある場合、リンクを変えてください。
推奨される日本語翻訳版サイト:
良い例:
Next.jsでは`export`された[React コンポーネント](https://ja.reactjs.org/docs/components-and-props.html) のことです。
悪い例:
Next.jsでは`export`された[React コンポーネント](https://reactjs.org/docs/components-and-props.html) のことです。
コードのデモを示す際に、末尾に:(コロン)で終わっている原文があります。
これは、。に置き換えず、そのまま:(コロン)を使ってください。
良い例:
./pages/index.jsの中に次の内容を記載します:
悪い例:
./pages/index.jsの中に次の内容を記載します。
用語の翻訳に一貫性を持たせるため、下記の単語についての翻訳をまとめました。随時追加中です。
| 用語 | 和訳 |
|---|---|
| Caveats | 注意事項 |
| Note | 備考 |
| How to use it | 使い方 |
| Introduction | はじめに |
| Related | 関連事項 |
| Import | インポート |
| Export | エクスポート |
| warnings | 警告 |
| parameter | パラメータ |
| production build | 本番のビルド |
| introduce to xx | xx の紹介 |
| learn more about | について詳しく学びましょう |
| xx documentation | xx のドキュメント |
原文のままの方がいい例として、以下 2 点あります。もし、翻訳するべきか分からない場合は Slack で質問してください。
- 原文の方がニュアンスを伝えやすい場合
- 日本語に訳すものが見当たらない場合
| 用語 |
|---|
| Imperatively |
| Automatic Static Optimization |