SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

DeveloperZine(デベロッパージン)- エンジニアの意思決定を支える技術情報メディア ProductZine

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

開発現場からお届け! Wantedlyのプロダクトを育て、支える技術

GitHubを使ったキャッチアップしやすいドキュメントの管理方法

開発現場からお届け! Wantedlyのプロダクトを育て、支える技術 第3回

打ち合わせの議事録

 打ち合わせの内容もIssueに記録するようにしています。リポジトリの設定にもよりますが、Issueに記載した内容は後から編集できます。

 しかしIssueは複数人数で同時に更新するとコンフリクトが起こるため、ノートのように打ち合わせ中にどんどん書き換えるという用途には向いていません。必要に応じて使うIssueのみを1人で編集するか、他のツールと組み合わせる方法を使い分けましょう。

 私たちは参加者が多い場合、Google ドキュメントをよく利用します。Google ドキュメントでは同時に複数の人が1つのドキュメントを更新でき、コンフリクトを避けられるからです。また議事録を1人だけで書く場合、書く人の担当箇所や理解の強弱で記述内容に偏りや抜けが発生しますが、参加者全員で編集すればそれらの問題を回避できます。

 実際の打ち合わせの流れは次の通りです。

  1. 打ち合わせを始める前に議事録係やファシリテーターがドキュメントを作成する。
  2. 参加者に編集可能な設定で共有する。
  3. 主担当が議事録を書いていく。
  4. 誤りや抜けは参加者が適宜加筆修正する。
  5. Google ドキュメントのURLと重要なことはIssueにコピー&ペーストする。
議事録と、そのまとめを書く
議事録と、そのまとめを書く

 Google ドキュメントには文章以外にもスプレッドシート(表計算)や図形描画などもあるため、議題に応じて組み合わせて使うといいでしょう。

重要な話はリポジトリのファイルにする

 Issue上で議論が行われ、話が長くなると、最終的に何が仕様なのかわかりにくくなります。多少仕様がブレてもプロダクトとして問題が無いなら些末なことですが、クリティカルなものについては別途リポジトリのMarkdownファイルやテキストファイルにまとめるようにします。こうしておくと最終的にまとまったものが明確になるため、チーム内の認識の齟齬を減らすことができます。

 また、それ以降の仕様変更の際に、そのファイルをgit blameすれば、必ず変更に関係するPRが見つかるため、誰が何の意図でそれを変更したかを追うこともできます。

キャッチアップの仕方

 個々のメンバーがIssueやPRを更新するため、その中には自分に関係があるものと無いものの両方が含まれています。全てのIssueやPRについて更新の有無を調べるのは無理ですし、時間の無駄です。

 GitHubにはNotificationsという機能があり、これを使うと情報のキャッチアップが捗ります。自分が参加しているIssueやPRの更新があると、Notificationsに通知されます。IssueやPRの参加者(participants)になっていれば通知されるため、自分を追加するといいでしょう。

Notifications
Notifications

 Wantedly独自の文化ですが、この方法として気になるIssueやPRに対して、下図のように:eyes:(目の絵文字)のみのコメントを行い、参加者になると同時に「見てるよ」という意思表示を行います。

:eyes:(目の絵文字)をコメントに書く
:eyes:(目の絵文字)をコメントに書く

次のページ
キャッチアップしてもらうときの配慮

この記事は参考になりましたか?

開発現場からお届け! Wantedlyのプロダクトを育て、支える技術連載記事一覧

もっと読む

この記事の著者

住友 孝郎(Wantedly, inc.)(スミトモ タカオ)

 WantedlyのAndroidアプリケーションの開発を主に担当する。代表作はWantedly PeopleとWantedly Chat。現在はアプリケーションの開発を主業務にしつつも、Web側を触ったりログの解析したりするなどプロダクトを育てるためにはなんでもやる。JavaでもRubyでもGoでもPythonでもC++でもSQLでもVBAでもGroovyでも雑多に触るけれどJavaが一番好き。 過去には産業機器向けWindowsアプリケーションや生産管理系...

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

この記事は参考になりましたか?

この記事をシェア

CodeZine(コードジン)
https://codezine.jp/article/detail/10486 2017/11/06 14:00

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー