Easy-to-read documentation in Japanese

オープン
#73 コメント 5 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
30/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
unity

調査の方向性

Issue にリンクされている日本語のコントリビューションドキュメントから始め、mrtk docs branch 内の対応する内容を見つけます。示されている用語と表現の例を確認し、そのうえで改訂が必要な日本語ページを特定します。選択したドキュメントが読みやすい日本語と一貫した開発者向け用語を使用していれば完了です。issue ではページの全体的な範囲は定義されていません。

索引モデルが issue の本文から書いたものです。

説明

documentation in progress

Describe the issue

I love the MRGT project.
When I look up information, I read the Microsoft Docs documentation, but as far as I can tell, the Japanese documentation is often machine-translated, and some of the expressions, phrasing, and grammar are difficult to read.
Also, for example, proper nouns and words that should be expressed in katakana, such as file names, have been forcibly translated into Japanese.

branch => ブランチ○ 分岐×(It is correct as Japanese "word" translate, but not used in developer word.)

In some cases, it is easier to understand by reading the original English documentation.

I will create documentation with the correct Japanese language and intent so that it is easy to read for other Japanese developers.

Feature area

・Examples of correct but not appropriate translations

"資産 フォルダー"× "アセットフォルダー" or "Assets フォルダー"○

・Example of unstable notation git Git

Failing to invoke the Window > Graphics Tools > Hide Samples menu item after editing samples will result in git thinking all sample files have changed. Once samples are hidden the actual files changed should be apparent in git.

スクリーンショット 2022-07-08 185054

Existing doc link

For example, with respect to documentation of contributions

https://docs.microsoft.com/ja-jp/windows/mixed-reality/mrtk-unity/mrtk3-graphicstools/contributing

image

The word clone is translated as "複製" which is similar in nuance to Duplicate.
Clone should be written in katakana as "クローン"(clone).

The following is a modification to make it easier to understand with these intentions.

From these, can fix the document as follows, as an example for clarity.

1.リポジトリをフォークし、ブランチを作成します。ブランチのネーミングはuser/username/featureの形を推奨しています。

2.GraphicsToolsUnityProjectのサンプルプロジェクトをUnityでクローンして開きます。

3.必要な変更を加えます。デフォルトでは、MRTK Graphics Tools パッケージ内のすべての編集は、Graphics Toolsパッケージに公開されます。(サンプルを更新したい場合は、以下のセクションを参照してください)。

4.あなたのブランチをあなたのフォークにプッシュし、プルリクエストを作成します。プルリクエストに変更点の説明を追加してください。画像やGIFの使用は歓迎されます。

Additional context

I have share other community members in Japan about MRGT: "It's useful!" URP and build-ins are all in one package! You can use it for projects other than HoloLens! I introduced MRGT to other community members in Japan, and some developers were interested in it.

I am sure that correct documentation in Japanese will help not only myself but also many other developers.

The documentation can be found in the docs branch of mrtk!
If MRGTTeam geve me OK to work on it .
I would appreciate it if you could let me know where I can contribute the Japanese documentation.

主要言語
C#
スター
209
フォーク
49
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

microsoft/MixedReality-GraphicsTools-Unity のほかの issue

microsoft/MixedReality-GraphicsTools-Unity の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。