Skip to content

Concept Document Creation Guide

本ガイドは、プロジェクト全体(<root>/docs/concept.md)および個別のソフトウェアコンポーネント(<root>/docs/[<group>/]<component>/concept.md)において作成する concept.md の記述内容とMarkdownテンプレートを定義するものです。

Section Guidelines

concept.md は、「何を作るのか(What)」と「なぜ作るのか(Why)」を明確化する最上位ドキュメントです。以下の2つの必須セクションで構成します。

1. 概要 (What)

  • 対象となるシステムまたはソフトウェアコンポーネントの全体像を記述します。
  • 何を提供するのか、どのような主要機能や構成要素を持つのかを簡潔かつ明確にまとめます。

2. 目的 (Why)

  • なぜこの開発を行うのか、背景や課題を明記します。
  • 解決したい具体的なニーズ、達成すべきゴール、および期待されるビジネス/技術的価値を記述します。

Template

以下は concept.md を作成する際の標準Markdownテンプレートです。コピーしてご利用ください。

markdown
---
name: concept.md
description: <システムまたはコンポーネントの1行コンセプト概要>
timestamp: YYYY-MM-DD
ai: ai-coauthored
---

# Concept

## 概要

<対象となるシステムまたはソフトウェアコンポーネントのWhat(何を作るのか)を記述します。主要な機能や提供価値の全体像を明記してください。>

## 目的

<開発の背景や解決すべき課題、達成ゴールなどのWhy(なぜ作るのか)を記述します。>