Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Easy-to-read documentation in Japanese #73

Open
HoloMoto opened this issue Jul 8, 2022 · 5 comments
Open

Easy-to-read documentation in Japanese #73

HoloMoto opened this issue Jul 8, 2022 · 5 comments
Labels
documentation Improvements or additions to documentation in progress This issue is currently being worked on

Comments

@HoloMoto
Copy link
Collaborator

HoloMoto commented Jul 8, 2022

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.

@Cameron-Micka Cameron-Micka added the documentation Improvements or additions to documentation label Jul 8, 2022
@Cameron-Micka
Copy link
Member

Thank you so much for offering to fix translation issues in our documentation @HoloMoto! I do not know how our docs get translated or how to make changes to specific languages. Let me add @tayomadein and @vtieto to this discussion. They are our documentation experts and might know how you can help!

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.

That is excellent to hear! ♥ I agree, proper Japanese documentation is important.

@Cameron-Micka
Copy link
Member

Cameron-Micka commented Jul 8, 2022

@HoloMoto I got a bit more info from the documentation team. They are going to request manual localization for Japanese. Hopefully that fixes some of the above issues! After that is complete, you are welcome to make changes by following these steps: https://docs.microsoft.com/windows/mixed-reality/contributing

@Cameron-Micka Cameron-Micka added the in progress This issue is currently being worked on label Jul 8, 2022
@HoloMoto
Copy link
Collaborator Author

Thank you! @Cameron-Micka @tayomadein @vtieto !
I had looked over the information on the link as well, but it seems to me that the localized document does not show the edit screen and only the original English document allows the edits described in the link.

They are going to request manual localization for Japanese.

Yes sir!
I will await that request and get to work!

@HoloMoto
Copy link
Collaborator Author

HoloMoto commented Aug 27, 2022

I am working in a local environment.
However, I still don't know how to edit and contribute to the localization page, so I sent an email to the Microsoft Docs localization team('[email protected]').
We'll see how this goes for a while!

Oh, I am impressed by the many features I have yet to use as I peruse the documentation.

image

@Cameron-Micka
Copy link
Member

Thank you for sending that! @vtieto for awareness. 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation in progress This issue is currently being worked on
Projects
None yet
Development

No branches or pull requests

2 participants