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

目次

概要

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

このあたりの情報ともマッチしているんじゃないでしょうか?

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

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

1

ドキュメンテーション

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

  • 納品、保守用のプロダクト
  • マニュアル生成用のOSS
  • ソースコード解析ツール

などは存在するが、
リエンジ用のドキュメント生成用途にはあまり適合しない。

設計書作成と作業形骸化

Windows Forms, Web Formsなど

  • 画面単位のモジュール化
  • コンポーネントベース
  • イベント・ドリブン

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

処理説明のリバース出力

  • プログラム設計レベルのフローチャートでは、条件分岐数が多くなりすぎ、
    フローチャートを一見して、詳細設計内容を理解することは難しいと考える。
  • このため、モジュールに詳細設計レベルの説明を付与するには、
    ドキュメンテーション・ツールのメソッド中コメントを使用して、
    メソッド定義書の「処理説明」に詳細設計内容を出力すると良いと考える。

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

A HotDocument?

  • A HotDocument?のメソッド中コメントのコメント ルールは単純で、
    コメントを「///」で開始することでメソッド中コメントを記述でき、
    コメント文字「/」を1つ増やすことによって字下げが可能になっている。
  • メソッド中コメント記述の際は、メソッド定義書に出力される
    「処理説明」の見易さなどを意識する必要がある。
2-1

サンプル プログラム

2-2

Excel出力例

2-3

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

2-4

参考

Doxygen

  • /*! ~コメント~ */を使用すれば、メソッド定義書に出力できる。
  • ただし、A HotDocument?と同様にメソッド中コメント記述の際は、
    メソッド定義書に出力される「処理説明」の見易さなどを意識する必要がある。

出力例

2-5

参考

進捗の管理方法

  • 設計書作成と作業形骸化で説明したような理由で、詳細設計作業以降の
    モジュール設計作業工程の成果物を作成しない場合、モジュール設計作業工程の進捗管理が困難になる。
3

添付ファイル: file2-5.png 166件 [詳細] file2-4.png 127件 [詳細] file2-3.png 148件 [詳細] file2-2.png 125件 [詳細] file2-1.png 154件 [詳細] file3.png 164件 [詳細] file1.png 141件 [詳細]

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2017-07-13 (木) 09:13:56 (587d)