CONTACT

BUSINESS教育事業

教育サービス

ソフトウェア開発におけるドキュメンテーションの重要性の認識と、品質と生産性の向上につながるドキュメントの作成およびレビューのスキル習得のための教育を提供します。
研修日数や受講者の経験など、ご事情に合わせて研修カリキュラムをご提案します。

特色

  • 実開発文書を教材とした演習や実習に対応できます。
  • 各種研修の部分的な組合せやご要望に応じた演習の設定が可能です。
  • 開発ドキュメントの重要性と必要性の動機づけを行った上で、ドキュメンテーション力を養成します。

ソフトウェアドキュメンテーション
関連研修

コースフロー例

受講者が、開発経験に合わせて(書き手としての)ドキュメンテーションから(読み手としての)レビューへと、自主的な改善活動につなげるための研修の流れを紹介します。
詳しくはこちら

<1>ドキュメンテーション
基礎スキル

研修概要

本研修では、ドキュメンテーションの重要性と基礎的な記述スキルを学びます。
まず、仕事を進める上でのドキュメンテーションの重要性と役割を理解します。
その上でドキュメンテーションスキルの基盤となる次の2つの技術を演習と実習によって習得します。

テクニカルライティング技術

技術文章を書く上での基礎技術

ドキュメンテーション技術

仕事を進める上でのドキュメンテーションの役割を正しく捉え、明確な目的の下で伝達したい内容を文書としてまとめ上げ、それを設定した読み手に伝える技術

受講対象

  • システム開発業務におけるドキュメンテーションの基礎技術を習得しようとする技術者や新入社員
  • システム開発業務のサポート部門(事務系管理部門など)の担当者

到達目標

  • 仕事(知識ワーク)におけるドキュメンテーション(情報伝達)の重要性を理解し説明できる。
  • 基礎的なテクニカルライティング技術とドキュメンテーション技術を習得する。
  • 学習した技術を使い、目的にかなう文書を作成できる。

前提条件

特になし

研修内容

1日間コース(6時間)または2日間コース(6時間×2)
※1日間コースは「第1日」のみの実施となります。

第1日

1.ドキュメンテーションの重要性(講義)ドキュメンテーションによる仕事の可視化/システム開発とドキュメンテーション/ドキュメンテーション力は仕事力
2.ドキュメンテーション基礎技術(講義・演習)言語技術・事実と意見の区別/パラグラフ・ライティング
3.テクニカルライティング技術(講義・演習)主語の明示/接続表現による論理的な記述
4.ドキュメンテーション技術(講義・演習・実習)合目的性/文書開発プロセス
【実習】各自の実文書の改善

第2日

5.ドキュメンテーション実習文書計画/文書設計
【実習1】業務文書の作成
【実習2】技術文書(要件定義書・取扱説明書 他)の作成
※各種報告書、業務説明書、作業手順書など、ご要望に合わせた実習テーマを設定できます。

<2>ソフトウェア
ドキュメンテーション

研修概要

ソフトウェア開発現場におけるドキュメンテーションの重要性を理解します。
その上で、ソフトウェア品質と開発プロセス品質の向上につながる開発ドキュメント作成のスキルを学びます。
具体的な事項として、次の事柄を理解し習得します。

  • ソフトウェア開発におけるドキュメンテーションの役割と実践
  • 開発ドキュメントの記述方法
  • ソフトウェア開発のためのライティングおよびドキュメンテーションのスキル

受講対象

  • 仕様定義や設計の業務担当者
  • 各種開発ドキュメントの作成担当者
  • 各種開発ドキュメントの査読担当者
  • ソフトウェア開発成果物のレビュー担当者
  • 開発チームのマネージャ,リーダー
  • ソフトウェア開発のプロセスと成果物の品質を向上させたい方

到達目標

  • ソフトウェア開発プロセスにおけるドキュメンテーションの意義を理解し説明できる。
  • ソフトウェア開発を、ドキュメンテーションに基づいて進め、管理する方法を理解し、業務に実践できる。
  • ソフトウェア開発ドキュメントには、「何を」「なぜ」「どのように」書くべきかを理解し、実際に作成できる。
  • ライティングとドキュメンテーションのスキルを高め、ソフトウェア開発を行う上で、目的にかなった明確な開発ドキュメントを作成できる。

前提条件

1~2年以上のソフトウェア開発経験があることが望ましい

研修内容

1日間コース(6時間)または2日間コース(6時間×2)
※1日間コースは「第1日」のみの実施となります。

第1日

1.ソフトウェア開発における開発プロセス(講義・演習)
2.ソフトウェア開発の現状(講義)
3.ソフトウェア開発におけるドキュメンテーションの役割(講義・演習)
4.ソフトウェアドキュメンテーションによるソフトウェア品質の向上(講義)
5.ドキュメント品質の向上(講義・演習)

第2日

【実習1】各自の開発ドキュメントの要件定義と各自文書診断(注)受講者各自が業務で作成したドキュメントを持参して実習します.持参不可の場合には、この部分を割愛し,その分の時間を[実習2]に充てます。
【実習2】要件定義ドキュメンテーションある組込みシステム開発の要求を分析・整理して、ソフトウェア要件定義書の一部を作成します。
(本実習教材は、名古屋大学NEP公開講座「要求仕様の開発技術」用に作成し、同講座にて使用したものです)

<3-1>ドキュメントレビュー
(基礎編)

研修概要

ソフトウェア開発を進める上でのドキュメントレビューの意義を学びます。
そして、演習と実習によって、品質向上につながるドキュメントレビューの実践力を養います。

※本研修の内容は、名古屋大学NEPの公開講座(組込みシステム技術者向け)でも実施しています。

受講対象

  • 各種開発ドキュメントの作成担当者
  • 各種開発ドキュメントの査読担当者
  • ソフトウェア開発成果物のレビュー担当者
  • 開発チームのマネージャ、リーダー
  • レビューに関わる組織の管理職、職場リーダ
  • ソフトウェア開発のプロセスと成果物の品質を向上させたい方

到達目標

  • ソフトウェア開発プロセス上のドキュメントレビューの意義を理解し説明できる。
  • ドキュメントレビューの方法を学び、業務に展開できる。
  • ドキュメントレビューを実施し、品質向上につながるレビュー報告書を作成できる。

前提条件

1~2年程度のソフトウェア開発経験があること

研修内容

1日(6時間)

第1日

1.レビュー総論(講義)レビューの位置づけと種類/レビューの有効性
2.ドキュメントレビュー要説(講義)ソフトウェア開発とドキュメンテーション/ドキュメントレビューとは/ソフトウェア文書診断/診断観点の検討/文書診断によるドキュメントレビュー
3.文書診断の実践(講義・演習・実習)
診断項目の確認/指摘事例
【演習】診断演習
【実習】ドキュメントレビュー実習
4.図表のドキュメントレビュー(講義・演習)
図表のレビュー/表の例/図の例
【演習】図が表現できること・できないこと

<3-2>ドキュメントレビュー
(実践編)実開発文書を適用した文書診断レビュー

研修概要

ソフトウェア開発を進める上でのドキュメントレビューの意義を学びます。
そして、演習と実習によって、品質向上につながるドキュメントレビューの実践力を養います。実践編の実習では、受講者が実際に業務内で作成した開発ドキュメントを使って、レビューや改善の要点を学びます。

受講対象

  • 各種開発ドキュメントの作成担当者
  • 各種開発ドキュメントの査読担当者
  • ソフトウェア開発成果物のレビュー担当者
  • 開発チームのマネージャ、リーダー
  • レビューに関わる組織の管理職、職場リーダ
  • ソフトウェア開発のプロセスと成果物の品質を向上させたい方

到達目標

  • ソフトウェア開発プロセス上のドキュメントレビューの意義を理解し説明できる。
  • ドキュメントレビューの方法を学び,業務に展開できる。
  • 各自の実開発文書を診断し、問題点とその改善点を挙げることができる。
  • 各自の文書診断によって、自身の仕事の位置づけや改善点を認識する。

前提条件

1~2年程度のソフトウェア開発経験があること

研修内容

1日(6時間)

※実開発文書による実習(第3章)以外は、上記の「ドキュメントレビュー(基礎編)」と同じ内容になります。

第1日

1.レビュー総論(講義)レビューの位置づけと種類/レビューの有効性
2.ドキュメントレビュー要説(講義)ソフトウェア開発とドキュメンテーション/ドキュメントレビューとは/ソフトウェア文書診断/診断観点の検討/文書診断によるドキュメントレビュー
3.実開発文書を使った文書診断の実践(実習)【実習】ドキュメントレビュー実習
【実習】改善点の検討
4.図表のドキュメントレビュー(講義・演習)図表のレビュー/表の例/図の例
【演習】図が表現できること・できないこと

<3-3>ドキュメントレビュー
(定着編)実開発文書に基づく継続的な改善活動の支援

研修概要

ドキュメントレビュー技術の基礎知識を学んだ上で、実開発文書を使った診断実習および、受講者自身が主体となる文書診断検討会を繰り返して、継続的な改善活動の定着をねらいます。

受講対象

  • 各種開発ドキュメントの作成担当者
  • 各種開発ドキュメントの査読担当者
  • ソフトウェア開発成果物のレビュー担当者
  • 開発チームのマネージャ、リーダー
  • レビューに関わる組織の管理職、職場リーダ
  • ソフトウェア開発のプロセスと成果物の品質を向上させたい方

到達目標

「<3-2>ドキュメントレビュー(実践編)」の目標に加えて、次の項目を目標とします。

  • 定期的な文書診断検討会を促し、書く能力とレビュー能力の双方を継続的に向上させる活動を定着させる。
  • 開発チームとしての書く能力とレビュー能力を向上させ、開発文書と開発プロセスの品質向上を実現できる開発力をもつチームを作る。

前提条件

1~2年程度のソフトウェア開発経験があること

研修内容

1日(6時間)

第1回
(1日)

1.「3-2. ドキュメントレビュー(実践編)」の内容(講義・演習・実習)
2. 各自ドキュメントの分析と改善演習(演習)

第2回
(半日)

実開発文書を使った文書診断の実践 (ドキュメントレビュー実習)(演習)ドキュメントレビュー実習形式とする(事前に講師側で文書診断&教材化します)。

第3回
(半日)

文書診断検討会(受講者主体の実開発文書の改善点に関する検討会)(コンサルティングを交えた参加者主体の勉強会)各自のドキュメントレビュー、グループでのレビュー結果の分析と検討、討議、改訂実習、講師による診断結果の解説などを、実開発文書や参加メンバーの状況などに合せて勉強会として進める。
※事前に講師側で文書を診断する。第3回では、講師による教材化はせず、受講者自らの文書診断、分析、改善を主体に行う。

第4回
(半日)

別の実開発文書に対する文書診断検討会(第3回に同じ)(コンサルティングを交えた参加者主体の勉強会)

以降
継続的に

実開発文書の文書診断検討会を継続的に実施する(コンサルティングを交えた参加者主体の勉強会)
※コンサルティングは必要に応じて実施
(たとえば、講師は診断結果を1つの例として提示する。参加者の診断結果に関する討議形式、または講師による診断例の理解と改善検討など、状況に合わせた進行を行う)

コースフロー例受講者の開発経験に合わせて開発ドキュメント関連のスキルの向上と発展を支援

ドキュメンテーションに関連するコースの受講フローを、受講者の経験によって設定した例です。
受講者が、開発プロジェクトメンバーとして業務経験を積んで行く段階に合わせて、開発製品や業務成果の品質向上に影響を与える開発ドキュメントに対する実践力を、それぞれの形態で提供します。

新入社員

  • <1>ドキュメンテーション基礎スキル

    【開催日程】1日間(2日間コースもあり:第2日は実習中心)
    仕事を進める上でのドキュメンテーションの基礎スキルを学ぶ。その基盤となるライティング基本技術、およびドキュメンテーション技術を使って、目的にかなう文書作成スキルを習得する。

  • <1a>ドキュメンテーション基礎スキル フォローアップ研修

    【開催日程】1日間
    <1>の研修後に、受講者が研修で得たことを実践し、いかに取り組んできたかを受講者自身が、実業務内で作成した文書を基に振り返り自己評価をして、今後の取り組みにつなげる基盤をつくる(ドキュメンテーションの取り組みに対するPDCAサイクル設定と管理)。

入社1年~

  • <2>ソフトウェアドキュメンテーション

    【開催日程】1日間(2日間コースもあり:第2日は実習中心)
    ソフトウェア開発における開発ドキュメントの役割を学ぶ。
    さらに、ソフトウェア品質と開発プロセス品質の向上につながる仕様書や設計書などの開発ドキュメント作成のスキルを習得する。

  • <2a>ソフトウェアドキュメンテーション フォローアップ研修

    【開催日程】1日間
    <2>の研修後に、受講者水準・受講者の取扱文書に応じて、 <1a>と同様に自己評価を行い、今後の取り組み基盤をつくる内容。

入社3年~

  • <3-1>ドキュメントレビュー(基礎編) または <3-2>ドキュメントレビュー(実践編)

    【開催日程】1日間
    作成されたソフトウェア開発ドキュメントに対するレビューを行う基礎技術を学ぶ。ライティング技術の指摘ができるようになるとともに、開発工程と文書の関係からの高度な指摘ができるようになることを目指す。

  • <3-3>ドキュメントレビュー(定着編)

    【開催日程】計2.5日間~
    基礎知識としてドキュメントレビュー技術を学んだ上で,受講者自らの実開発文書を使った診断実習と参加者が主体となる文書診断検討会によって,継続的な改善活動の定着をねらう。

イオタクラフトは,実開発文書に対する文書診断サービスを提供しています。
上記のコースは、文書診断のための基礎技術を体系立てたものです。
オンサイト研修(個別企業向け)のほか、その一部を、以下の公開講座で継続的に実施しています。

  • 組込みシステム産業振興機構主催「組込み適塾」にて「システム開発ドキュメンテーション」講座(2008~)
  • 名古屋大学NEP公開講座(組込みシステム技術者対象)にて「ドキュメントレビュー」講座(2009~)
  • CQ出版エレクトロニクスセミナ
    「ソフトウェア開発成功のカギを握る仕様書や設計書の書き方・まとめ方――組み込みソフトウェア・ドキュメンテーション入門」(2009~)
    「ソフトウェア開発の品質を上げる,仕様書や設計書のレビュー技術――ソフトウェア・ドキュメントレビュー入門」(2015~ )

PAGETOP