システム開発文書の品質向上への取り組み2014年2月27日塩谷敦子SHIOYA Atsukoシステム開発文書品質研究会(ASDoQ)幹事合同会社イオタクラフト執行役員目次序:小手調べ1.背景2.システム開発文書品質研究会3.システム開発文書品質への取り組み4.おわりに
Net   Association of System Documentation Quality
1
意味の違いを説明してください。また、開発文書内の記載として指摘すべき点があれば挙げてください。 ①Aが起動するあいだ、Bを初期化する。 ②Aが起動するあいだに、Bを初期化する。
Arc   Association of System Documentation Quality
0 Oシステム開発文書に求められる品質説明力システム開発プロセスと開発文書●開発文書不備が引き起こす問題の例●開発文書の役割oシステム開発文書の品質研究のきっかけ
Net   Association of System Documentation Quality

■開発プロセスの整備
■様々な規格ISO 9001(品質マネジメントシステム規格) IEC 61508(機能安全規格) ISO 26262(自動車版機能安全規格)... ■　開発情報の管理◾　トレーサビリティの確保■　上流工程を重視する開発技法■形式手法モデルベース開発… ■
■国の動き
■組込みソフトの安全性の見える化が重要であり、国際標準も踏まえた、公的機関による第三者監査体制の整備が必要(経済産業省産業構造審議会情報経済分科会(第25回)一配布資料より) http://www.meti.go.jp/committee/materials2/downloadfiles/g100402a061j.pdf
Art   Association of System Documentation Quality

●システム開発文書は、システム開発を行う上での、関係者間（文書の書き手と読み手）におけるコミュニケーションの媒体のひとつ●システム開発において、あるプロセスの出力であり、次のプロセスの入力（ASDoQ用語集wiki「システム開発文書」から） Art   Association of System Documentation Quality
開発文書は、「開発の結果」と「開発プロセス」と「品質」を可視化する。なにを(What)作るか？結果を見せる何をやるかを見せる構築方法･手法を見せる何をやったかを見せるどうやって(How)作るか？プロセスを見せる開発の構成･関係･手順を見せる開発の内容・担当・管理を見せる開発の経過と結果を見せる品質を見せる開発成果の妥当性を見せるプロセスの妥当性を見せる品質活動の計画・実施・評価を見せる(同)イオタクラフト「ソフトウェアドキュメンテーション」研修教材からArc   Association of System Documentation Quality 7システム開発文書の品質研究のきっかけ■開発文書の品質を明らかにし、それを高めることを目指せばシステム開発は、開発品質と開発生産性を高められるのではないか？ ■ソースコードは、様々なメトリックスが計測され、その品質が議論されているのに、なぜ、仕様書や設計書の品質を測る手立てがないのか？
Art   Association of System Documentation Quality

●研究会の概要●活動状況会員の専門領域●
All Association of System Documentation Quality

■組込みシステム・情報システムの開発■システム開発のプロセスやQCDの改善活動■形式手法,派生開発などの開発手法の普及・推進■ソフトウェア・ドキュメンテーションの指導■テクニカル･ライティングの指導■日本語文章内のあいまい表現の研究■自然言語処理の研究■コミュニケーションの研究■大学,高等専門学校でのシステム開発技術者の教育■技術文書の編集･出版など多種多様
Art   Association of System Documentation Quality

●　これまでの成果O活動紹介1:関連する用語の議論と定義o活動紹介2:開発文書技術リストの作成O活動紹介3 :ライティングルールに基づく例文作り
Net   Association of System Documentation Quality

■公開中の成果物
●用語集v0.0(http://asdoq.jp/yougo/) ●ソフトウェア要求仕様書のサンプル( http://asdoq.jp/research/jinzai.html ) ●研究論文「開発文書品質の研究課題についての考察」信学技報. vol. 111, no. 282, KBSE2011-45, pp. 55-60,  2011年11月.山本修,栗田,山本佳■会員が現在共有できる成果物●活動進行中の成果物(全会員向け) ■開発文書品質の特性◾開発文書技術リスト■用語集wiki版◾文例作成（良い文、悪い文） ●会員向け資料（全会員向け） ◾実施したイベントの報告・配布資料●作業部会の情報（部会メンバ向け） ■各部会の活動内容■その他の成果物●研究ロードマップ(White Paper)第0版Art   Association of System Documentation Quality
用語集v0.0 ＜公開＞ □〉 [議論の場]用語集wiki＜会員限定＞ (全会員が編集可･用語定義の継続的な議論と表現改善を行う) ■ ASDoQ標準用語の定義<目的> 「システム開発文書品質」を研究する上で必要となる用語の定義や扱い方に関する方針を示す。 〈対象とする用語〉 ASDoQで使用する新しい用語と、その定義に深く関係する用語を対象とする。 「システム開発文書品質」「システム開発文書」 「文書品質」「システム開発」の4用語
<目的> 「システム開発文書品質」に関連する用語の中で、重要であると思われるものをリストアップし、調査と整理を行う。さらに、既存の定義の中から推奨する定義や指針となる定義を示す。 ( http://asdoq.jp/yougo/)
く対象とする用語>
曖昧な意味、複数の意味を持つために使い方に迷いが生じる用語を対象とする。 ｢アーキテクチャ設計｣,｢システム開発プロセス｣ ｢品質｣などの31用語Arch  Association of System Documentation Quality
開発文書技術＜会員限定＞（全会員が入力可） ●文書作成技術の一覧●システム開発技術の一覧<目的> 。システム開発文書の品質に関連する既存技術を整理し、索引として活用できるものを作る。 。様々な分野からの会員が持つ知見を文書品質の視点で結集する。
良い例文・悪い例文リスト＜会員限定＞ ｢日本語スタイルガイド｣[※]のルールを基に、システム開発文書を作成する上での解説と例文を作成する。 ([※]テクニカルコミュニケータ協会「日本語スタイルガイド第2版」)ルール9：「まで」と「までに」を使い分ける.（[※]内の番号3.5.4）解説： 「まで」と「までに」は、厳密には異なる「まで」は継続範囲（期間、場所など）の終端を、 「までに」は許容範囲の終端を示す。しかし、分かりにくいので、継続範囲か許容範囲かを明示的に示す語句を付加して使用する. [システム要求仕様書](例文を想定した開発文書の種類) △ EEPROMへのデータ書き込みが完了するまで「BUSYメッセージ」を送信する. （継続範囲） O EEPROMへのデータ書き込みが完了するまで、10msecおきに「BUSYメッセージ」を送信し続ける. △ EEPROMへのデータ書き込み完了するまでに「BUSYメッセージ」を送信する.（許容範囲） O EEPROMへのデータ書き込みが開始してから完了する前までに,どのタイミングでも良いから1回以上「BUSYメッセージ」を送信する.注）<小手調べ>(p2)での「あいだ」(継続期間を表す)と「あいだに」(許容期間を表す)も同種の扱いとなる([※]による) Association of System Documentation Quality
●システム開発文書の品質を向上する今後の取り組み●
nt   Association of System Documentation Quality

システム開発文書の品質の向上は、 「各開発工程での成果品質」と「開発プロセスの品質(仕事の品質)」と「製品の最終品質」を向上させることにつながる
Association of System Documentation Quality

■これまでの成果oロードマップ■技術課題の整理■知識体系化ほか●用語定義●関連する既存の文書技術の確認■文書技術のリストアップ■開発文書への適用のための例文作成】 ●開発文書サンプル■目指す成果物●開発文書品質の定義●開発文書晶質の計測方法●開発文書品質の向上方法これまでの成果を、まず「システム開発文書品質」を明らかにすることに発展させる■取り組んでいく事項○開発文書品質を示すための特性･指標とは？ ●高品質の開発文書の要件とは？ ●共通する文書技術とは？
Art   Association of System Documentation Quality

あすどっくシステム開発文書品質研究会（ASDoQ） <Web> http://asdoq.jp/ <E-mail> secretariat@asdoq.jp(事務局)
Association of System Documentation Quality
21