Skip to content

Instantly share code, notes, and snippets.

@kmaehashi
Created July 26, 2013 06:44
Show Gist options
  • Save kmaehashi/3e013b3aab03d17232e9 to your computer and use it in GitHub Desktop.
Save kmaehashi/3e013b3aab03d17232e9 to your computer and use it in GitHub Desktop.
ドキュメント管理ポリシー (いつ、だれが、何を(どの範囲のものを)直すか?)

方針

  • GitHub の Jubatus (organization) 配下のドキュメント (Webサイト, Wiki) は常に最新版に追従する。

    • リリースのタイミングでは、最新版に追従している、または修正が必要であるという内容の Issue が切られている状態にする。
    • ただし、ハンズオン資料については、次回のハンズオンのタイミングで反映する。
  • 上記以外の資料は、Jubatus チームとしてはメンテナンスしない

    • 資料作成者の判断で加筆修正してもよいが、変更したことが判るようになっていることが望ましい(特に対外発表したもの)

更新のトリガー

原則として、実装/変更担当者がドキュメントをメンテナンスする(または誰かにディスパッチする)。

トリガー アウトプット
新タスク実装 API リファレンス
               |理論解説 (少なくとも参考文献リスト)

アーキテクチャ変更 |アーキテクチャ概要 |理論解説 (少なくとも参考文献リスト) 外部仕様変更 |変更箇所 対外発表 |Publications ページ 新メンバー参加 |メンバー一覧

@rimms
Copy link

rimms commented Aug 5, 2013

LGTM 👍

@y-oda-oni-juba
Copy link

LGTM

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