Contributionの手順をドキュメント化する

rust-lang-ja / book-ja

Rust文書の和訳レポジトリ

https://doc.rust-jp.rs/book-ja/

Other

290 stars 101 forks source link

Contributionの手順をドキュメント化する #83

Open tatsuya6502 opened 4 years ago

tatsuya6502 commented 4 years ago

TODO まだ書きかけです。

手順の概要
1. GH Issueで手を上げる（アサインしてもらう）
2. PRをオープンする
3. ...
対訳表について
mdbook-transcheckについて
mdBookのバージョンについて
CIについて（特にartifactsページ）

emergent commented 3 years ago

rust-jp Slackの方でもコメントいたしましたが、日本語として読みやすくような翻訳時の指針があるとよいと思います。

現状の翻訳では、以下のような接続詞が漢字で書かれていて少し読みづらいと感じましたので、こういうのは平仮名で書くとよいかと思いました。

従って
即ち
何故なら

scivola commented 3 years ago

接続詞の「従って」「即ち」「何故なら」などを仮名にすること，およびそういう表記ルールを指針にすることについて賛成ですが，例えば接続詞でなく動詞の「従って」は漢字のほうが適当でしょう。実例を挙げると

慣例に従って書かれています
この手順に従ってインストールした
新しいバージョンに従って
IEEE-754規格に従って表現されています

とかですね。指針を書く際に，こういった品詞による仮名・漢字の表記の仕分けが分かりやすくなっているといいかな，と思いました。

ksato9700 commented 3 years ago

横から失礼します。私もついさっき知ったのですが、「JTF日本語標準スタイルガイド(翻訳用）」というガイドラインがあるようです。https://www.jtf.jp/tips/styleguide これに必ず従わなければならないというものでは無いと思いますが、ひらがなと漢字の使い分けなど参考になる部分が幾つかあると思いました。

そして、textlint というツールがあって、https://www.npmjs.com/package/textlint-rule-prh というルールを適用すると表記ゆれの検出・修正ができそうで、試しに edition-guideの翻訳文に適用してみようかと思っています。https://www.npmjs.com/package/@azu/prh.yml にはJTFのスタイルガイドのルールも入っているようです。