skillup

技術ブログ

ドキュメント作成

設計業務での改善点など

投稿日:2021年7月4日 更新日:

比較的大規模なプロジェクトの設計段階で思ったことなど。

明確なゴールを決める

会議や打ち合わせのたびにポツポツと問題点が出てきてしまい、設計などがひっくり返る、なかなか決まらないことが多い場合、ユースケースから満たすべきテストケースを割り出し、そのテストケースを満たすことをゴールと考えると良いのではないかと思います。理想論かもしれないが・・・・

プログラムを造らない段階でもデータイメージは想定することが可能なため、テストケースの想定は可能なはず・・。

理想論を追求しすぎるといつまでたっても決まらないことが多いため、ある程度現実的な案を考えましょう。

どうしたら「ゴールになるのか」という点を明確に設けるように。

レビュー時はチェックリストを設ける

レビューのたびにポツポツと問題点が出てくる場合、仕様、ドキュメントの体裁的なことに関して、チェックポイントを決めておくと内容に差異がなくなると思います。

チーム内での情報の情報共有方法を考える

チーム内での仕様の認識に齟齬が出るのは仕方ないかもしれませんが、各人でレビューをしあう、説明をし合うなどして、一人の人間が仕様を握っているということがないようにしておくと良いと思います。

データのテストパターンが一番現実的だと思います。

出来るだけ情報の同期ができる便利なツールを使う

1つの資料の情報の変更が、別の資料にも影響されるような資料を作るのが良いでしょう。

Excelであればなるべく関数やマクロを使い、手作業での修正量を押さえることが必要。(1つの修正で何箇所も修正が発生するような事態をなるべく避ける)

開発時と連携できるような資料がベスト(コードからドキュメントが開発できるなど)

-ドキュメント作成
-

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

障害報告などでの伝える情報の視点

障害の重要度(後続タスクにブロックがあるかいなか)、調査原因(仕様不理解、設計考慮もれ、ケアレスミス)、影響度(画面単位などで) 障害が起こっているデータ(あるいはスクショなどで伝えられるか) 再現プ …

no image

ドメイン決定&業務フローとの対応確認

Contents1 ドメイン決定2 業務フローとの対応2.1 実際の業務とエンティティ、画面の遷移2.2 ドメインのCRUD分析 ドメイン決定 業務フローを抽出し、エンティティを抽出した段階で次にドメ …

no image

コード静的解析ツールを使った際の気づきなど

最近のプロジェクトでコード静的解析ツール(phpcs,phpmd)を使った際の気づきなど コードを書きながら常時エディタがチェックするタイプのものでないとまず無理(保存するたびでも無理だし、コミット時 …

no image

使える設計書作成に関して

私自身、この仕事を7〜8年やっておりますが、設計書作成については常に悩まされておりました。 設計書のメリット・デメリットとしては以下のようなものですかね。 メリット メンバー間での仕様の認識を統一でき …

no image

ディレクション時に重要な視点

ディレクション(ベンダーや内製時)時に留意するポイント Contents1 開発ルールの構築2 アサインと人材スクリーニング3 言葉の共通化(特にアウトプット)4 問題化のキャッチアップ5 リソースの …