Open棟梁 wiki」は、「Open棟梁Project」,「OSSコンソーシアム .NET開発基盤部会」によって運営されています。

目次

概要

ドキュメント標準のポイント

ドキュメント標準化ワークフロー

設計ドキュメントの標準化のためのワークフロー概要図

1

ドキュメンテーション

設計書作成と作業形骸化

Windows Forms, Web Formsなど

などを実現するフレームワークを活用する場合、詳細設計作業以降のモジュール設計作業の形骸化が発生することがある。
(MVCなどの柔軟性の高いフレームワークを使用する場合、モジュール設計作業工程が重要になるケースもある。
大規模開発でMVCが標準のJavaを使用するケースなどでは、モジュール設計書から、スケルトンの自動生成をしている事が多い。)

ドキュメンテーション・ツール

などは存在するが、

リエンジ用のドキュメント生成用途にはあまり適合しない。
前述の「設計書作成と作業形骸化」の防止に利用できる。

処理説明のリバース出力

※ メソッド中コメントが入っていないプログラムでは
メソッド定義書の「処理説明」欄に詳細設計内容を出力できないので注意する。

A HotDocument?

2-1

サンプル プログラム

2-2

Excel出力例

2-3

HTML、ヘルプ ファイル出力例

2-4

参考

Doxygen

出力例

2-5

参考

進捗の管理方法

3

参考

OSSコンソーシアム

Think IT(シンクイット)

即活用!業務システムの開発ドキュメント標準化

記事一覧
https://thinkit.co.jp/series/6536

令和時代のシステム開発では、どのような設計書を書くべきか

記事一覧
https://thinkit.co.jp/series/9344

変わらない開発現場


トップ   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS