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

翻訳協力フローの整備 #27

Open
inatus opened this issue Feb 28, 2014 · 15 comments
Open

翻訳協力フローの整備 #27

inatus opened this issue Feb 28, 2014 · 15 comments
Labels

Comments

@inatus
Copy link
Contributor

inatus commented Feb 28, 2014

翻訳辞書も出来ましたし、まだ翻訳すべきドキュメントが大量にあるので、
そろそろ本格的に翻訳協力をしてもらえるスキームを考えませんか?
具体的には、まずできるだけ丁寧な手順のwikiページを整備することを想定しています。
以下のように、翻訳手順と必要な前準備を考えてみました。

前準備

issueにまだ翻訳できていないドキュメントのチケットを未アサインで上げておく。

翻訳手順

  1. 翻訳したいドキュメントのチケットを自分にアサインする。
  2. レポジトリをフォークする。
  3. ドキュメントに翻訳元ドキュメント情報を追加し、翻訳ルール・翻訳辞書にしたがって翻訳する。
  4. 翻訳辞書への追加、翻訳辞書の内容について議論が必要な場合は、専用のissueチケットで質問する。
  5. 翻訳が終わったらコミットし、pull requestを出す。(コミット時には必ずissue IDを添える)
  6. 運営側で英訳のレビューをし、マージする。必要なら運営側で修正も行う。
  7. 運営側でissueチケットをクローズする。

上記翻訳手順をできるだけ丁寧に(github初心者にもわかるように)wikiに書くイメージです。

いかがでしょうか。

@inatus inatus added the kaizen label Feb 28, 2014
@atotto
Copy link
Member

atotto commented Mar 2, 2014

おぉ。いよいよ本格的な感じですね。

チケットは最初にあげてしまったほうがよさそうですね。
これはwikiにある翻訳リストの内容でいいでしょうか?

翻訳手順ですが、いいと思います。
最初の「チケットを自分にアサインする」というのは、本プロジェクトにメンバとして参加しておく必要があるのでしょうか?メンバ以外からのPullReqをもらう場合はどうしましょうか。

wikiのほうは好きにいじってもらって大丈夫です!

@inatus
Copy link
Contributor Author

inatus commented Mar 2, 2014

チケットは最初にあげてしまったほうがよさそうですね。
これはwikiにある翻訳リストの内容でいいでしょうか?

これは、自分でチケットを上げるよりも入りやすいと思ってアイデアを上げてみました。
翻訳リストの内容で良いと思います。
よろしければ私の方で時間のあるときにチケットを上げておきます。

最初の「チケットを自分にアサインする」というのは、本プロジェクトにメンバとして参加しておく必要があるのでしょうか?メンバ以外からのPullReqをもらう場合はどうしましょうか。

あ、すみません...
そもそもメンバ以外の人がPullReqをする手順を想定してましたので、ここは変える必要がありますね。
"Assigned"的なラベルを用意しておいて、チケットにコメントを書いてもらったら、運営側がチケットにAssignedラベルを追加することでアサインされていることがわかるようにしましょうか。
運営の負担が若干増えるのでアレなんですが...

@inatus
Copy link
Contributor Author

inatus commented Mar 3, 2014

とりあえずなぐり書きしてみました。

翻訳協力フロー

@atotto
Copy link
Member

atotto commented Mar 4, 2014

なぐり書きありがとうございます!

すこし文言等を修正しました。

ちなみに、

はあえて別物にしてますか??

@atotto
Copy link
Member

atotto commented Mar 4, 2014

チケットはなにかスクリプトでも作ってつくってもいいのかなとか思いますが、既になにか準備されていますか?
http://godocjp.herokuapp.com/status/translate.html にあるadd issueリンクのように
https://github.com/gophersjp/go/issues/new?labels=translation&title=%2e%2fdoc%2fdocs.html&body=link%3a%20https%3a%2f%2fcode.google.com%2fp%2fgo%2fsource%2fbrowse%2fdoc%2fdocs.html
とかみたいにクエリをつくればそれなりにラクができそうなのですがが。

@inatus
Copy link
Contributor Author

inatus commented Mar 4, 2014

ご確認ありがとうございました!
修正もありがとうございます。

  • 翻訳協力フロー と
  • 翻訳フロー
    はあえて別物にしてますか??

既存の文書を書き換えてしまうのもあれなので、一旦別文書に起こしましたが、別である必要はないと思います。
強いて言えば、別にするならコミットできる人向けとそうでない人向けに分けるぐらいですかね。
あんまりコミットできる人向けにはいらないと思うので、1つで良いと思います。

チケットはなにかスクリプトでも作ってつくってもいいのかなとか思いますが、既になにか準備されていますか?

まだ準備していません。
スクリプトを使えれば楽で良いのですが、少し大変そうですね。。。
これについてはまず、翻訳対象には下記の2種類があると思っています。

  • まだ一度も翻訳されていない新規のもの
  • 翻訳済みだが本家に更新があったもの

後者については、手動でトラッキングするのは大変なので、自動スクリプトがあると良いかもしれませんね。
前者については、一度切りですし数が限られているので、スクリプトを作るのが大変なら手動で上げてしまってもまあいいかなとも思います。
上で書いた

issueにまだ翻訳できていないドキュメントのチケットを未アサインで上げておく。

は基本的に前者を想定していました。

@inatus
Copy link
Contributor Author

inatus commented Mar 5, 2014

あ、すみません。
またちゃんと読んでませんでした(汗)

そうですね、URLだけ自動で作ってあげて、手作業で登録する半自動化良いと思います。
せっかくなのでGo言語でつくってみます。。。

@inatus
Copy link
Contributor Author

inatus commented Mar 5, 2014

あるいは、http://godocjp.herokuapp.com/status/translate.html にまだ翻訳されていないものもリストになっていると良いかもしれませんね。

@atotto
Copy link
Member

atotto commented Mar 5, 2014

ですね、そう思って改造できないかちょっと見ています。うまく行けばそこからチケットを起票してもらうという方法でもいいのでしょうか?

@inatus
Copy link
Contributor Author

inatus commented Mar 5, 2014

早速のご返信ありがとうございます!
検討の方もありがとうございます。
最初の一回だけの話なので、もし、あまり手間がかかるようでしたら
私の方で手動でやるか、ちょっとしたツールでも作ってやりますね。

@atotto
Copy link
Member

atotto commented Mar 5, 2014

と言ってる間にできちゃいました・・
http://godocjp.herokuapp.com/status/translate.html

いまは doc.goと*.htmlだけを見るようにしています。

@inatus
Copy link
Contributor Author

inatus commented Mar 5, 2014

おお!さすがです!
これでいきましょう!

ではこれにしたがって手順を修正しておきますね。

@inatus
Copy link
Contributor Author

inatus commented Mar 5, 2014

更新しました。TODOのところも書いておきました。

翻訳協力フロー

ちなみに、タグの目的って、翻訳ステータスページで最新化チェックするためです...よね。。。

あとひとつちょっとした問題に気づいたのですが、すでに翻訳を始めたチケット(まだプッシュしてない)が存在する場合にはかぶっちゃう可能性がありますね。そこは自分で重複チェックしてもらうようにしましょうかね。

@atotto
Copy link
Member

atotto commented Mar 8, 2014

ありがとうございます!

タグの目的

そうです。リビジョンのタグが得られれば他の方法でもいいのですが、手っ取り早いのでこの方法を・・という感じですね。。

すでに翻訳を始めたチケット(まだプッシュしてない)が存在する場合にはかぶっちゃう可能性が

たしかにそうですね。いい対策ではないですがひとまずチケットの検索リンクをつくっておきました。
http://godocjp.herokuapp.com/status/translate.html#non_translated
たぶん既に上がっていれば引っかかると思います。

@inatus
Copy link
Contributor Author

inatus commented Mar 8, 2014

ご確認ありがとうございます。
検索ボタン良いですね!
非常にわかりやすいので、これでもう初心者でも(?)迷うことはないと思います。

検索ボタンについての説明も追加しました。
一応これで完成ですね。
WikiとREADME.mdあたりにリンクを貼ろうと思いますが、
既存の翻訳フローと内容を置き換える形がよいですかね。
それとも既存のドキュメントは残しておいてリンクだけ付け替えますか?

あと、assignedラベルは必要ないことになったので、紛らわしいので消しておきます。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants