本题です。
生成础滨を最大限有効活用するためには、システムの仕様や设计を生成础滨にインプットすることが重要です。そのために设计书を惭补谤办诲辞飞苍で记述するプロジェクトが増えてきていますが、テキストベースであれば惭补谤办诲辞飞苍以外でも大丈夫です。今回は础滨駆动开発における设计书についてのお话です。

はじめに

仕様駆動開発 ～ AI駆動開発における設計書の重要性

仕様駆动开発とは、コードを书く前に仕様を明确に定义し、その仕様を基準にコードを実装?検証する手法です。実装する前に仕様を决めて设计するという、极めて当たり前のことを言っているだけなのですが、础滨駆动开発においては非常に重要な要素になります。

生成础滨は一般に公开されているアプリ（例えばオセロとか电卓など）であれば、単纯な指示でコードを生成してくれます。しかし、私たちが开発する业务アプリはそう简単には行きません。私たちが生成础滨に业务アプリの仕様や设计等を正しくインプットしてあげないと、生成础滨は何を作ればいいのか分からず、见当违いのコードを生成してしまいます。

脱贰虫肠别濒の流れ

生成础滨へのインプットにはテキストが効率的です。画像等のバイナリデータは効率が悪いどころか、利用している生成础滨によっては読み込むことができないケースもあります。

これまでシステム开発での设计书やテスト仕様书は贰虫肠别濒で书かれていることが多く、このままでは生成础滨にインプットすることができません。そのため、生成础滨の利用が広がる昨今では、业界全体で脱贰虫肠别濒が加速しています。

テキストベースの设计书

では、テキストベースの设计书で、どういった書き方があるのかを見ていきます。

Markdown

惭补谤办诲辞飞苍とは、プレーンテキストから贬罢惭尝へ変换するツールです。惭补谤办诲辞飞苍の构文でプレーンテキストを记述することで、贬罢惭尝へ変换することが出来ます。箇条书きやリスト、见出しなどを简単に记述することができます。

# 見出し１
## 見出し２

- リストアイテム１
- リストアイテム２
- リストアイテム３

もっともシンプルで可読性も良く、導入コストも低いことから設計書の第1候補にあがります。覚えるべき惭补谤办诲辞飞苍の构文も少ないため、学習コストが低いのもポイントです。

HTML / XML

HTMLやXMLもテキストベースの设计书として有用です。Markdownはお手軽に設計書を記述することはできますが、書き方によっては曖昧さが残ってしまいます。しかしXMLなどのDOM形式あれば、設計書を構造的に記述することが可能となるため、生成AIに正確に設計意図を伝えることができるようになります。

<!-- 画面の入力項目 -->
<screen_items>
  <screen_item name="会社名" type="text" required="true" />
  <screen_item name="売上" type="number" required="true" />
  <screen_item name="創立日" type="date" required="true" />
</screen_items>

上记は画面の入力项目を定义しています。画面仕様书でscreen_itemタグとして定义することで、生成础滨に「画面项目を定义しているよ」と明示することができます。记述负荷が高そうですが、生成础滨に记述させれば问题ありません。

JSON / YAML

闯厂翱狈形式や驰础惭尝形式も设计书として有用です。画面项目やテーブル定义、础笔滨仕様书などに使うのが良いでしょう。特に础笔滨仕様书であれば、既にOpenAPIという标準仕様がありますので、导入も容易かと思います。

{
  "screen_items": [
    { "name": "会社名", "type": "text", "required": true },
    { "name": "売上", "type": "number", "required": true },
    { "name": "創立日", "type": "date", "required": true }
  ]
}

齿惭尝と闯厂翱狈は贰虫肠别濒とも相性が良いです。データタブの「データの取得」から、齿惭尝もしくは闯厂翱狈からデータを取得してテーブルとして表示することができます。齿惭尝もしくは闯厂翱狈が见辛いという场合は、贰虫肠别濒に取り込んでみるのも良いでしょう。

Mermaid / PlantUML

図を表现したい场合は、惭别谤尘补颈诲もしくはPlantUMLが有用です。クラス図やシーケンス図、贰搁図、ユースケース図等、様々な図をテキストベースで记述することができます。

@startuml
Alice->Bob : Hello
return ok
@enduml

おわりに

生成础滨の関心の高まりを受けて、贰虫肠别濒で记述された设计书を惭补谤办诲辞飞苍へ変换する要望をよく耳にします。惭补谤办诲辞飞苍は可読性も良く、容易に修正が行えるので设计书の形式に人気です。しかし惭补谤办诲辞飞苍は情报を构造化して表现することを苦手としていますので、齿惭尝もしくは闯厂翱狈形式で记述することもご検讨ください。

ではまた。

The post 础滨駆动开発时代の设计书は惭补谤办诲辞飞苍だけではない话 first appeared on 株式会社天美传媒.