翻訳に対応したコンテンツの記述について
記述したコンテンツが正常に翻訳されるようにするには、次のガイドラインを使用します。 詳細については、「スタイル ガイド」を参照してください。
- 一般的で、ほとんどの人が理解できる例を使用します。
- 議論の余地がある、またはあるグループに対して文化的に固有である例は避けてください。
- 能動態で書きます。
- シンプルで短く、わかりやすい文を書きます。
- テキストが不明確になる可能性がある代名詞を多く使用しないようにします。
- スラングやジョークは使用しないでください。
- 否定文は避けてください。
- 可能な限り業界標準の頭字語を使用し、カスタムの頭字語については説明します。
- 直接法を使用します。
- 冗長な表現は除外します。
- 複数の修飾語 (名詞文字列) を過度に使用しないようにします。 翻訳者が、修飾されているのはどの名詞かを誤って解釈する可能性があります。
- 最初の名詞が単数形か複数形かが明確にされない、不可視の複数形は避けてください。
- 名詞化は避けてください。
- あいまいな法助動詞を使用しないでください。
- ジェンダー固有の単語は避けてください。
- 前置詞句は避けてください。
- あいまいな名詞と代名詞 (あいまいな文の主語) は避けてください。
- インライン リンクは最小限に抑えます。 必要に応じて、それらの前に "詳細については、「リンク タイトル」を参照してください。" などの語句を追加します。 または、トピックの最後にある「参考文献」セクションに関連するリンクを追加します。
例
このセクションでは、翻訳に適したドキュメントを作成するためのガイドラインに従う方法の例を示します。
国固有の情報を避ける
たとえば、800 という番号や国固有の住所は避けてください。 必要に応じて、情報が適用される国について言及します。
複数の修飾語 (名詞文字列) を過度に使用しない
複数の修飾語を多く使うと、何が何を修飾しているかを判断するのが簡単ではなくなるので、誤訳につながる可能性があります。 たとえば、"public repository default source settings" (パブリック リポジトリの既定のソース設定) ではなく、"Default source settings for the public repository" (パブリック リポジトリの既定のソース設定) を使用します。
不可視の複数形を避ける
たとえば、"file retrieval" (ファイル取得) という用語を使用する場合、1 つのファイルを取得するか、それともすべてのファイルを取得するかが不明です。 あいまいさを排除するために、さらに多くのコンテキストを提供します。 指定した例では、"retrieving all the files" (すべてのファイルの取得) または "retrieving the source.md file" (source.md ファイルの取得) を使用できます。
名詞化を避ける
たとえば、"to reach a conclusion" (結論に達するには) ではなく "conclude" (結論) を使用します。
あいまいな法助動詞を使用しないでください。
"may" や "may" などの単語は使用しないでください。 あいまいさを避けるために、より明確にしてください。
前置詞句を避ける
"何回も試した後" や "リポジトリ ログに従って" と書くのではなく、より直接的に記述します。 たとえば、"3 回試行した後" などです。
あいまいな名詞と代名詞を避ける
あいまいな名詞や代名詞を使用すると、特にそのコンテンツを翻訳する必要がある場合、誰について、または何について言及されているかが不明確になる可能性があります。 たとえば、"Maintainers and contributors have access to files and comments. In the pull request they make changes to it." (保守担当者と共同作成者はファイルとコメントにアクセスできます。pull request で、変更を加えます。) などです。 この文では、ファイルまたはコメントのどちらに変更が加えられているかが明確ではありません。 代名詞が複数の先行詞を指しているように思える場合は、先行詞を明確にするために文を書き換えるか、代名詞を名詞に置き換えてあいまいさを排除します。
インライン リンクを最小限に抑える
可能な場合は、スタイル ガイドに従ってリンクを明確に紹介してください。 たとえば、次の文ではなく、
Read [more about OAuth2.](/apps/building-integrations/setting-up-and-registering-oauth-apps/) Note that OAuth2 tokens can be [acquired programmatically](/rest/reference/oauth-authorizations/#create-a-new-authorization), for applications that are not websites.
代わりにこれを使用できます。
OAuth2 tokens can be acquired programmatically for applications that are not websites. For more information, see "[Setting up and registering OAuth Apps](apps/building-integrations/setting-up-and-registering-oauth-apps/)" and "[Create a new authorization](/rest/reference/oauth-authorizations/#create-a-new-authorization)."