第4回産業日本語研究会・シンポジウム

システム開発文書の品質とは何か
システム開発文書品質研究会（ASDoQ） 事務局長
長野工業高等専門学校 助教
藤田 悠

Association of System Documentation Quality目次
1. システム開発と文書の関係
2. 「システム開発文書品質研究会」の紹介
3. ASDoQにおける取り組みの紹介

Association of System Documentation Quality

2

システム開発と文書の関係

Association of System Documentation Quality

3

システム開発と文書
要求定義書・設計書

1.機能
1.1 温度制御
ランプ温度が120度以上になったとき、ファンを回転させ温度上昇をおさえる。140度以上になったときは、ブザーを発して警告する。警告から10分間で温度低下がみられない場合、スタンバイ状態に移行する。
1.2 動作表示
LCDに動作を表示する。
動作毎に表示する文字列を以下の表に定義する。

プログラム

システム

int main(){while(1) {PORT_A = 0x01;
PORT_B = 0x02;
if(REG_A == 1)
PORT_C = 0x01;
else
PORT_C = 0x00;}
return 0;}

システム開発の過程では，プログラム言語や自然言語などで文書を作る
Association of System Documentation Quality

4

システム開発で作る文書システム適格性確認テスト

システム要求分析
システム方式設計

システム結合ソフトウェア適格性確認テスト

ソフトウェア要求分析

ソフトウェア方式設計

ソフトウェア結合

ソフトウェア詳細設計

単体テスト

コーディング
JIS X 0160:2012 ソフトウェアライフサイクルプロセス

複数の工程をつなぐために，文書を介して，開発を進める
Association of System Documentation Quality

5

システム開発における文書の役割• 各開発工程ですべきことを定義する
対照

工程Aの開発内容

目次
1.
2.

本書の概要
システムの機能• 開発成果を表し，次工程に指示する
工程１

工程１の開発成果
かつ工程2へ作業指示

工程２• 文章によって正確に伝達する
工程１作業者の理解

目次
1.
2.

本書の概要
システムの機能

Association of System Documentation Quality

工程２作業者の理解
第三者の理解6

文書が開発に与える影響
開発工程間の手戻り
ソフトウェア要求分析

問い合わせコストが増加?

ソフトウェア方式設計
コーディング

要求と成果物の不一致
顧客の要求

≠

保守や修正のコスト増加

成果物

Association of System Documentation Quality

7「システム開発文書品質研究会」の紹介

Association of System Documentation Quality8アスドックシステム開発文書品質研究会（ASDoQ）
種別
設立
会員
会費

任意団体
2011年7月11日
個人会員（83名），法人会員（12社），法人登録会員（25名）（2013.2.11現在）
原則無料
定期研究会：

活動

ASDoQ大会：

年に3～4回
技術発表，作業部会の報告
年に１度開催講演，チュートリアル

ワークショップ：

特定のテーマを合宿で集中討議

作業部会：

現在，３テーマを設置

Association of System Documentation Quality

9研究会の目的
1. 文書品質の提案
2. 計測技術の研究
3. 文書品質の普及（参考）設立当初に考えていた素朴な疑問
・開発文書の品質を明らかにし，それを高めることを目指せば，システム開発は今以上に，開発生産性と開発品質を高められるのではないか？
・ソースコードは，様々なメトリックスが計測され，その品質が議論されているのに，なぜ，仕様書や設計書などは，手がつけられていないのか？
Association of System Documentation Quality

10研究活動とその活用• 研究成果（非競争領域）– 開発文書の品質の定義– 開発文書品質の計測方法– 開発文書品質の向上方法– 品質の高い開発文書例

研究会への参加者は，「システム開発文書品質研究会著作物取扱規則」に合意し，成果の自由な利用を保証する• 研究成果の活用（競争領域）– 文書品質の計測・向上– プロセス品質検証の透明性向上– 技術者教育カリキュラムの開発・実施– アウトソーシング時の提供文書の品質向上– 文書品質計測プログラムの開発・改良– 文書品質改善ビジネスの発展
品質の定義を共有し，各活動領域で応用，発展させる
Association of System Documentation Quality

11

会員の活動領域• 組込みシステム・情報システムの開発• テクニカル・ライティングの指導• ソフトウェア・ドキュメンテーションの指導• 自然言語処理の研究• 大学，高等専門学校の教員• 技術書籍の編集• コミュニケーションの研究• 形式手法，XDDPなどの普及・推進など多種多様
様々な活動領域に発展させ，様々な側面から開発文書の品質を追求する
Association of System Documentation Quality

12

ASDoQにおける取り組みの紹介

Association of System Documentation Quality

13

各作業部会での活動■ロードマップ部会 (主査：名古屋大学 山本修一郎)
開発文書に関連する研究状況を整理，分析する．
システム開発文書技術白書を作成．
■用語定義部会(主査：イオタクラフト 塩谷敦子)「システム開発文書品質」に関連する用語を説明する．
先行研究での文書品質の性質を整理する．

■人材育成部会(主査：名古屋大学 山本雅基)
文書を作成できる技術者を育成する．
文書の品質を高めるために必要な教育の検討．
Association of System Documentation Quality14

ロードマップ部会目的システム開発文書品質に関する技術知識を整理し，文書品質研究のロードマップを作る．

活動内容
システム開発文書品質に関する技術知識体系をまとめる．（研究ロードマップ「White Paper」）
文書品質に対するニーズとシーズのギャップを明確にする．
Association of System Documentation Quality

15

用語定義部会
目的
ASDoQにおいて，文書の品質の研究活動を進める上で、共通の概念として統一しておくべき用語を定義する．
システム開発文書品質システム開発

活動内容

文書品質

システム

「システム開発文書品質」を構成する用語や，文書の品質を研究するうえで必要になる用語の定義や扱い方などをまとめる「用語集」を作成中．
Association of System Documentation Quality16

人材育成部会
目的
文書を作成する能力や評定する能力をもつ技術者
およびこれらの能力をもつ技術者を育成する管理者のための教材を作る．
ムーブレボ通報システムの組込みソフトウェアの要求仕様書を作成する

ムーブレボ

活動内容
品質が高いと認める開発文書をメンバー自身が作成する．文書作成の過程で得られた経験を共有する．
Association of System Documentation Quality

17

「システム開発文書の品質特性」への取組み～巨人の肩に立つ～• 技術文書を作成する技術を学ぶ
システム開発文書の属性をまとめる• 研究・教育・実務での事例を学ぶ
優れた取り組みを積み重ねる• 将来，文書品質特性のデータベースとなる• 文書品質の計測を行う際に，参考とする• システム開発文書品質の特性の参考とする
Association of System Documentation Quality18

共通する文書力と開発のための文書力• 技術文書に共通する文書品質– 特許文書– マニュアル– システム開発文書

特許文書

マニュアル

開発文書などに共通する文書技術を生かす．

• 「システム開発」のための文書品質– 配慮しなければならない記述– より厳密性を求められる内容– 分野ごとに求められる特徴などの知識を「形式知化」する．
Association of System Documentation Quality

19品質が高い文書は人を育てる

Web :http://asdoq.jp/E-mail:secretariat@asdoq.jp（事務局）

ASDoQ
Association of System Documentation Quality

検索20

Association of System Documentation Quality

21