Skip to content

docs: 翻訳ガイドラインを作成#18

Merged
mkpoli merged 18 commits into
mainfrom
feat/style-manual
Jul 7, 2024
Merged

docs: 翻訳ガイドラインを作成#18
mkpoli merged 18 commits into
mainfrom
feat/style-manual

Conversation

@mkpoli

@mkpoli mkpoli commented Jun 23, 2024

Copy link
Copy Markdown
Contributor

Closes #15, #16

@mkpoli

mkpoli commented Jun 23, 2024

Copy link
Copy Markdown
Contributor Author

Based on Disscussion on Discord, the consensus are towarding not inserting half-width space (U+0020) manually.

https://discord.com/channels/1196431244158849064/1251938021314400306/1254457656500949152

@3w36zj6 3w36zj6 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM: 構成は概ね良いと思います。

Comment thread README.md
Comment thread README.en.md
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO: 箇条書き内での敬体と常体の混在は避けた方が良いかもしれません。

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

体言「~すること。」や名詞列挙の場合はどう扱うべきなのかについては、ちょっと考える必要がありそうですね。

Comment thread CONTRIBUTING.md Outdated
@3w36zj6

3w36zj6 commented Jun 23, 2024

Copy link
Copy Markdown
Member

作業の重複を防ぐため、翻訳に着手する前にIssueでの宣言を推奨する旨の文章を追加すると良いかもしれないと思いました。

@stepney141 stepney141 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

全体的な内容はこれで良いと思います。ただし、

  • 全体として、書式の修正や文体の統一が必要です。
  • 翻訳ガイドラインの遵守をもう少し強制してもいいと思います。
  • 「参考」節に載せている他プロジェクトの翻訳ガイドの内容をもっと取り入れても良いと思います。

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md

## スタイルマニュアル

スタイルマニュアルでは、当プロジェクトにおける翻訳の品質確保のための、統一したスタイルの参照基準を提供します。具体的には、基本、文体、表記、用語の4つの観点から、翻訳の際に留意すべき事項を示します。

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

日本語では、並列する複数の単語を1つの文に併記するときは、中黒「・」を使うのが一般的です。

Suggested change
スタイルマニュアルでは、当プロジェクトにおける翻訳の品質確保のための、統一したスタイルの参照基準を提供します。具体的には、基本、文体、表記、用語の4つの観点から、翻訳の際に留意すべき事項を示します。
スタイルマニュアルでは、当プロジェクトにおける翻訳の品質確保のための、統一したスタイルの参照基準を提供します。具体的には、基本・文体・表記・用語の4つの観点から、翻訳の際に留意すべき事項を示します。

@mkpoli mkpoli Jun 24, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

それが特にカジュアルの文体で一般的であるのは存じ上げておりますが、やはり書籍などの編集では、語句の並列などで、中黒を使わないほうが推奨されているようですので、あえて中黒から読点に変えました。

https://www.jtf.jp/pdf/jtf_style_guide.pdf
image
image

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO:

  • 箇条書き内での敬体と常体の混在は避けたほうが良いと思います。
  • 「参考」節に載せている他プロジェクトの翻訳ガイドの内容をもっと取り入れた方が良いと思います。

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

・Further disscussion in: https://github.com/typst-jp/typst-jp.github.io/pull/18#discussion_r1651166806
・体力がなくなりましたので、取り入れてほしい内容があれば取り入れておいてくださると助かります。

Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md

文体については、以下のガイドラインに従ってください。

1. 基本的に「です」「ます」調の敬体を使用すること。ただし、引用、見出し、箇条書きなどに関しては、その限りではありません。

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. 基本的に「です」「ます」調の敬体を使用すること。ただし、引用見出し箇条書きなどに関しては、その限りではありません。
1. 基本的に「です」「ます」調の敬体を使用すること。ただし、引用見出し箇条書きなどに関しては、その限りではありません。

Comment thread CONTRIBUTING.md Outdated
Comment thread README.en.md
Comment thread README.en.md Outdated
mkpoli and others added 4 commits June 24, 2024 23:26
Co-authored-by: 3w36zj6 <52315048+3w36zj6@users.noreply.github.com>
Co-authored-by: 3w36zj6 <52315048+3w36zj6@users.noreply.github.com>
Co-authored-by: 3w36zj6 <52315048+3w36zj6@users.noreply.github.com>
Co-authored-by: 3w36zj6 <52315048+3w36zj6@users.noreply.github.com>
@mkpoli

mkpoli commented Jun 24, 2024

Copy link
Copy Markdown
Contributor Author

作業の重複を防ぐため、翻訳に着手する前にIssueでの宣言を推奨する旨の文章を追加すると良いかもしれないと思いました。

現在は小さい修正を行い、DraftPRとして作成することで、翻訳開始の宣言が行われていますが、別にIssueを立てると、やはり余計に手間がかかってしまうようです。できるだけ翻訳作業の手順を減らしたいので、一つの代替案としては、こちらでまだ翻訳されていない箇所に対して、全部のIssueを立て、そこに興味がある人は、そこでコメントするとアサインされ、作業を始めることができると思います。いかがでしょうか。

ただし、これは大方の翻訳が終わり、修正・更新作業のみ残っている場合、どうすればいいのかも考える必要がありそうですね。

mkpoli and others added 6 commits June 24, 2024 23:50
Co-authored-by: stepney141 <stepney141andi.c.i@gmail.com>
Co-authored-by: stepney141 <stepney141andi.c.i@gmail.com>
Co-authored-by: stepney141 <stepney141andi.c.i@gmail.com>
Co-authored-by: stepney141 <stepney141andi.c.i@gmail.com>
@gomazarashi

Copy link
Copy Markdown
Contributor

翻訳されていない箇所に対して、全部のIssueを立て、そこに興味がある人は、そこでコメントするとアサインされ、作業を始める
個人的にはその方式でよいと思います。

@3w36zj6 3w36zj6 changed the title 翻訳ガイドラインを作成 docs: 翻訳ガイドラインを作成 Jun 25, 2024
@mkpoli

mkpoli commented Jul 2, 2024

Copy link
Copy Markdown
Contributor Author

@stepney141 さらなるフィードバック待ってます

@gomazarashi

Copy link
Copy Markdown
Contributor

https://github.com/vuejs-translations/docs-ja/blob/main/.github/CONTRIBUTING.md
こちらで言われているような行の追加・削除に関してはどのように扱いましょうか?
(英語版ドキュメントの変更の取り込み方にもよるでしょうが...)

@mkpoli

mkpoli commented Jul 2, 2024

Copy link
Copy Markdown
Contributor Author

https://github.com/vuejs-translations/docs-ja/blob/main/.github/CONTRIBUTING.md こちらで言われているような行の追加・削除に関してはどのように扱いましょうか? (英語版ドキュメントの変更の取り込み方にもよるでしょうが...)

できる限り変えないほうが確かに楽に差分しやすいので、そのほうが良いかもしれません。

@stepney141

Copy link
Copy Markdown
Member

大変遅くなりまして申し訳ありません。とりあえずこの内容で運用してみて、問題点があればその都度直していくようにすればよいかと思います。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ドキュメント翻訳用の約物・書式・文体・用語などを規定するスタイルガイドの整備 CONTRIBUTING.mdの作成

4 participants