生成AI時代のドキュメント基盤

~ 金融SIでの実践事例紹介 ~

ドキュメントの重要性

生成AIの活用が進み、ドキュメントの重要性の再認識

仕様駆動開発にも注目

  • AWS - Kiro
  • GitHub - Spec Kit

新たな課題の出現

<--
そうした中で、ドキュメントを扱う上で、新たな課題も出現しています。
とくににドキュメントの納品が求めらえがちな受託開発案件では顕著な課題かと思います。
-->

ドキュメントの2つの課題

  • ドキュメント体系
  • ドキュメント基盤

ドキュメント体系

仕様駆動開発の本質

  • どのように役割を分割し
  • どのような構成にするか
  • ドキュメント間の関係性は?

ドキュメント基盤

  • どのように作成し
  • どのように管理し
  • どのように運用するか?

2つの視点

  • ドキュメント体系 : どう構成し、どのように役割分担するか
  • ドキュメント基盤 : どのように作成・管理・運用するか

後者が本発表のスコープです。

本発表の内容

  • 大手金融3社のSIプロジェクト
  • Markdownベース
  • 800ページ超
  • 最長7年の持続性

これらの事例とノウハウを紹介します。

自己紹介

T.B.D

ドキュメント基盤要件

  • AIフレンドリー
  • 単純な図の簡便な作成
  • 複雑な図の作成
  • 表の簡便な作成
  • 表の他ツールとの共有
  • 単一PDF出力
  • git管理
  • Pull Requestベースのレビュー
  • 差分とプレビューの両立
  • CI/CD
  • 検索を含めた高い閲覧性
  • 高い拡張性
  • 十分なセキュリティ
  • 低コスト
  • 保守ステージのコストゼロ

さてみなさん、生成AI活用されていますか? 生成AIの活用がどんどん進む中で、ドキュメントの重要性が再認識されていると思います。

そんな中、AWSからはKiro、GitHubからはSpec Kitが登場し、仕様駆動開発も注目を集めています。 ドキュメントの重要性が増していることの表れだと思います。

ソフトウェア開発におけるドキュメントを考えたとき ドキュメント体系と、ドキュメント基盤の2つの視点に分けて 考える事もできるかと思います。 ちなみにこの考え方は近い考えはありますが、必ずしも普遍的なものではなく あくまで本発表における定義です。

本発表でいうドキュメント体系とは、ドキュメントをどう構成し、どのように役割分担するか ドキュメント間の関係性はどうするか、という視点です。 仕様駆動開発の本質に関わる部分でもあります。

一方でドキュメント基盤とは、ドキュメントをどのように作成・管理・運用するか、という視点です。 あくまでドキュメント体系を支える基盤であり、技術的な側面が強い部分です。

本発表のスコープは、ドキュメント基盤の部分です。

私たちは7年前、従来のOffice文書ベースのドキュメントから脱却することを決意し Markdownベースのドキュメント基盤を構築・運用してきました。 比較的ドキュメントへの要求水準が高い、大手金融3社のSIプロジェクトで800ページを超えるドキュメントを 最長7年にわたり持続的に運用してきました。 この7年の間に、多くの苦労を経験し、ノウハウを得ることができました。 本発表では、私たちが実践してきた事例とノウハウを包括的に紹介します。