peketamin/tasks_board.md

## tasks_board.md

      
    Raw
  

              tasks_board.md
            
          
    ref: [O] Design Doc 的な何か用の Wiki 記法によるテンプレ
今日どのチームの誰が何をするか、今何をしているかの一覧と過去ログがCRUDできるアプリを作る

プロジェクトの目的

何を実現するの？


今どの人がどんなことをしているかをトピックとして知れる

プロジェクトの背景

どんな背景があるから実現するの？


チャットをいっぱい見ていても、作業中のつぶやきや報告でしかなく、

その当日どんなことに取り組んでいるか分からない。
そのチームの島まで行って、カンバンを見ればいいのかも知れないが、移動が面倒。
同じ組織の人間が何をしているかを知らずに動くのは、精神衛生的にしんどい。

ハイレベルアーキテクチャ

コードだけでは分からない作成物のアーキテクチャを画像などで


UI 層:

ボード表示
　- タスクリスト表示

コメント表示
過去ボード選択


管理画面

ユーザー管理
チーム管理
チームボード管理
コメント管理


アプリケーション層:

ユーザー入会、退会 (Oauthベース)

アクセス権限編集


チーム作成
タスクCRUD
当日チームボードにチームごとのタスクを書き込む

コメントCRUD


ドメイン層:

チームボード

タスク

コメント


ユーザー

ロール (アクセス権限)


チーム

サブチーム

ユーザー


インフラ層:

MySQL


プロジェクトの参加者

連絡先が大切。誰が参加するのかを明らかにしよう


自分

仕様（とくに従うべき仕様がなければ飛ばす）

実装する仕様

事前に仕様が決まっていたら


チームボード上の各タスクへのコメントは一人 1 つまで
時系列で書かれるものの、スレッドのような使い方ではない
チームボードは未来の予定も登録・閲覧・編集・削除できる

既存のものとの相違点

既存のものと何が違うのか、比較対象の仕様があれば言えるだろう


Trello: 「どのステータスか」は気にしない
Trac / Redmine: 「どのステータスか」は気にしないし、進捗も関心事ではない

関連する仕様

関連する仕様があれば


管理者が1人、初期登録されておく必要がある

インストール時に作成できると良いなぁ


各クラスの概要

各クラスの概要を書く

TBE
実装

インターフェイス

各クラスのインターフェイスの概要。hファイルや、javadocやpod形式かな。関数や構造体を定義するコードとコメント。

TBE
処理フロー

「どのように処理をおこなうか」を各関数内の処理フローを上記で説明したインターフェイスに基づき、自然言語で詳細に書く

TBE
作成物の使用例

おもにサンプルコード

TBE
セキュリティやプライバシーについての考察

考えられる問題と、それに対する対処方法
TBE
既知でオープンな問題

事前にわかっている様々な課題

TBE
テスト計画、モニタープラン

思いついたテストを思いついただけ書く

TBE
テストケースの記述

TBE
運用時の考慮。障害の発見方法や、復旧方法など

TBE
参考文献

参考文献を書く

TBE
レポジトリ

サーバのアドレスや位置

TBE
Docの編集の履歴

編集日、編集者、何をしたのか、の3つ組を書く


2015-12-09: 横山: 仕様にチームボードに未来の予定を登録できる事項を追加
2015-12-09: 横山: 初版