lean-ja / fp-lean-ja

Functional Programming in Lean の日本語訳. 演習問題への解答を含みます(作業中 🚧)
https://lean-ja.github.io/fp-lean-ja/
Other
7 stars 2 forks source link

和訳方法について wiki を使う提案 #22

Closed imamuray closed 3 months ago

imamuray commented 4 months ago

現状、「翻訳の際のルール」や「対訳表」がリポジトリのファイルとして管理されていますが、これらを Github の wiki で管理するとよいのではないかと考えました。 参考: ウィキについて - GitHub Docs

メリット

デメリット

Seasawher commented 4 months ago

提案ありがとうございます

たしかにPRマージ前に対訳表の変更が見られるのは便利ですね.また対訳表はPRマージ時にコンフリクトが発生する主要な部分であり,対訳表がなければコンフリクトが発生しなくなるというメリットもありそうです.対訳表を wiki に移すのはいいかもしれません.

wiki のアクセス権限の仕様は

ウィキは、GitHub 上で直接編集することも、ウィキのファイルをローカルで編集することもできます。 デフォルトでは、リポジトリへの書き込みアクセス権を持つユーザのみが Wiki に変更を加えることができますが、GitHub.com のすべてのユーザがパブリック リポジトリの Wiki に貢献できるようにすることも可能です。

という風になっているようですが,運用するなら GitHub.com の全ユーザが編集できるようにしておくと便利かなと思いました.

@aconite-ac いかがでしょうか

aconite-ac commented 4 months ago

@imamuray @Seasawher

個人的には以下の2つの理由により、wiki で対訳表を管理するのはあまり得策ではないように思っています。

前提として、対訳表は翻訳において非常に重要な要素だと考えており、 レビューする際はかなり細かく単語をピックアップし、注意深く訳語を検討したいと考えています。 まず翻訳ルールを再検討し、実際に上記のプロセスに則りレビューをしてみて、何か問題がありそうなら wiki を使う方法を含め再検討させていただきたいと思います。

(ただ、考えを詰め切れていない気もします……。対訳表と訳語決定プロセスについて、ご意見ありましたら伺いたく思います。)

imamuray commented 4 months ago

@Seasawher @aconite-ac

検討ありがとうございます。

提案した手前ではありますが、私自身改めて考えてみて、wiki の有無よりも翻訳ルールや対訳表の更新がどのような手順で行われるかが明確になることが元々の問題意識としてあったと思います。 複数人が PR で和訳作業を進める中で、PR 間のコンフリクトを起こさず翻訳ルールや対訳表を更新する手段の一つとして wiki の利用があると考えます。そのため wiki を使用せず、権限を持った人が任意のタイミングで README や GLOSSARY を更新する方法も手段としてはあると考えます。

@aconite-ac さんの提案は更新プロセスとしてよさそうだと思いました。

この issue 作成時の懸念点として、和訳 PR 作成者が対訳表の更新や訳語選びを意識して PR を出さなければいけないと考えていましたが、提案いただいた方法なら PR 作成者は一旦個人の見解で作業を進めることができ、対訳表の更新も検討したうえで更新されるので私が考えていた懸念点は解消できそうです。

Seasawher commented 4 months ago

問題ないと思いますが、レビュアーの負担が大きくなるので運用してみて難しそうならまた考えましょう

imamuray commented 3 months ago

現状、wiki を使わないでも運用できそうではあるのでこの issue は一旦クローズでいいと思います。