Files
2026-02-16 13:58:02 +09:00

2.2 KiB

name: ipa-dd description: Alias for ipa-detail — generate API_SPEC.md and DB_DESIGN.md from SRD and UI_SPEC. Use when referring to the detail design stage by its legacy name, generating interface and data design specs, or completing Stage 3 of the IPA pipeline. Trigger phrases: "generate detail design", "create api spec and db design", "ipa dd".

Do NOT generate API_SPEC/DB_DESIGN until UI_SPEC.md exists. Run ipa-design first.

TIP: ipa-detail is the canonical name for this skill. ipa-dd is kept for backward compatibility. Both produce identical output.

Overview

Generate Detail Design (Stage 3) following IPA standard. Platform agnostic — works with any project type.

Output:

  • docs/API_SPEC.md — Interface specifications (API/CLI/MCP/Chat)
  • docs/DB_DESIGN.md — Data design (SQL/NoSQL/Vector/File)

When to Use

  • SRD.md and UI_SPEC.md both exist
  • Ready to define API contracts and database schema
  • Completing Stage 3 of the IPA pipeline

Don't Use When

  • UI_SPEC.md does not yet exist (run ipa-design first)
  • SRD.md is missing (run ipa-spec first)

Project Type Handling

Project Type Interface Spec Data Design
Web App REST/GraphQL API SQL/NoSQL
Desktop App IPC/Native API SQLite/Local
CLI Tool Commands/Args/Flags Config files
MCP Server Tools/Resources/Prompts
Chatbot/RAG Conversation flows Vector DB
Library/SDK Public API/Methods

Language-Agnostic Principle

API_SPEC.md uses OpenAPI 3.x standard (YAML/JSON), standard HTTP methods, JSON Schema — no framework-specific code.

DB_DESIGN.md uses standard SQL (DDL), ER Diagram (Mermaid), portable data types — no ORM-specific syntax.

Workflow

  1. Read docs/SRD.md for entities and features
  2. Read docs/UI_SPEC.md for screen → API mapping
  3. Generate docs/API_SPEC.md (OpenAPI standard)
  4. Generate docs/DB_DESIGN.md (SQL standard)
  5. Add implementation notes if tech-stack.md exists
  6. Ask user to review

Traceability Check

  • Every table corresponds to an E-xx
  • Every endpoint links to an FR-xx

Next Steps

After generation: run planning skill to create implementation tasks.