Easy-to-read documentation in Japanese

Abierto
#73 5 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
30/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
unity

Línea de trabajo

Comienza con la documentación japonesa sobre contribuciones enlazada en el issue y localiza el contenido correspondiente en mrtk docs branch. Revisa los ejemplos de terminología y redacción proporcionados y, después, identifica qué páginas en japonés necesitan revisión. Se considera terminado cuando la documentación seleccionada utiliza un japonés legible y una terminología coherente para desarrolladores; el issue no define el alcance completo de las páginas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
C#
Estrellas
209
Forks
49
Métricas de merge de PR
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de microsoft/MixedReality-GraphicsTools-Unity

Todos los issues de microsoft/MixedReality-GraphicsTools-Unity

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.