ドキュメント勉強会に参加してきました
遥か昔の出来事の様な気がしますが8月6日にメビック扇町で開催されたドキュメント勉強会へ行ってきました。
そもそもドキュメントって何でしょう？私はお客様にサイトの構成、仕様や操作の流れ等を説明する為のコミュニケーションを目的とした資料だと思っていましたが、それで合っているのか悩んでいたので、他の方のドキュメント作成のルールやTipsなど他の方の意見を聞ける良い機会でした。
勉強会のお題は「Poken販売サイト」を作る事を前提としたドキュメントについての発表。
shin1x1さん
- 使用ツール：MS Visio
- ドキュメントの書き方は技術なので覚えて共有する。
- システムの全対構成を図式化する
- メインフロー(ワークフロー)
- 流れ、役割、登場人物を把握する
- ER図
- 一番最初にラフ書きしてたたき台にするのも可
- 画面遷移
- 画面仕様書
- 画面イメージと画面仕様とIN/OUT
- DBが更新系の場合に作成する
ポイント：
- 一つのドキュメントにすべてを詰め込まない
- 見せながら説明する事を想定する
今まで詰め込みすぎた事があったので大いに頷きました。
shinoiさん
- 使用ツール：MS Excel
- 想定したシステム作りの流れを作る
- お客様向けではなく社内スタッフ向け
- システム要件
- サーバ、OS、文字コード、想定ブラウザ、Webサーバ、言語等
- 準備してもらうもの(提出してもらうもの)
- 公開側/管理側の画面遷移
- DBテーブルのリスト(DB設計書)
- ER図
- フォルダ構成
- スケジュール
やっぱりここまで作るべきだなあとしみじみと感じました。
loungepさん
- 小企業対象
- 経営者層に理解してもらうドキュメント
- 経営者は「何ができるか」のみを知りたい
- ページ数規模、導線を見せる
- 担当者が何をできるかを作成
- 費用見積に関わる事を明確にする
- スケジュール、業務担当分岐点
ドキュメントは経営者に対してのプレゼン資料ですね。納得です。
msngさん
- コミュニケーションツールとしてのドキュメント
- デザイナーのためのドキュメント
- デザイナーにはデザインの依頼、目的を達成するための提案をお願いする。
- そもそも何の為の提案かを説明する。
- プログラマーの為のドキュメント
- 目的が見えない、目的地が見えないことを改善する為に今はどこにいるのかどこからどこまでのロードマップドキュメント
- オーナーの為のドキュメント
- 仕様変更かバグフィックスか
- ユーザーの為のドキュメント
- PCやネットに詳しくない人向け
一言にドキュメントといってもいろんな人向けのがあるという事を改めて思いました。
yabumaruさん
- 実際の業務で使用されたドキュメントを元に発表
普段は絶対にお目にかかれない大変貴重な資料でした。
悩んでいた部分がスッキリしたのと、今後ドキュメント制作する上での色々なヒントを頂きました。
勉強会の後は沖縄料理のお店で懇親会。楽しかったです。
他の方によるドキュメント勉強会レポ等はslywakerさんの勉強会まとめに一覧があります。
http://studybookmark.net/studies/view/4a805653-71c0-457b-a84d-7d227c253a82
