doc-dd-api

Generate and update API detailed design documents with mandatory frontmatter.

1|Updated Feb 11, 2026
One-click install
npx skills add https://github.com/tsuji-tomonori/diopside-v3 --skill doc-dd-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-dd-api
Source: https://github.com/tsuji-tomonori/diopside-v3/tree/main/.opencode/skills/doc-dd-api
Command: npx skills add https://github.com/tsuji-tomonori/diopside-v3 --skill doc-dd-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the creation and revision of API detailed design (DD) documents, ensuring they adhere to the diopside Obsidian operational standards.

Core Features & Use Cases

  • API Design Documentation: Generates DD-API documents for internal API processing, input validation, exception mapping, and idempotency.
  • Standard Compliance: Ensures documents follow Obsidian operational rules and include all mandatory frontmatter keys.
  • Use Case: When updating the API interface specifications due to a basic design change or a new requirement, use this Skill to draft the detailed design document that focuses on processing flows, constraints, and error handling, ensuring it aligns with OpenAPI specifications.

Quick Start

Use the doc-dd-api skill to create a new API detailed design document for the endpoint 'users'.

Frequently Asked Questions about doc-dd-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API detailed design documents that align with OpenAPI specifications?

To generate API detailed design documents aligned with OpenAPI specifications, use this Skill to draft processing flows, input validation, and error handling while ensuring compliance with mandatory frontmatter standards.

What is the best way to document internal API processing, input validation, and exception mapping?

Documenting internal API processing, input validation, and exception mapping is best handled by generating a detailed design document that captures processing flows, constraints, and error handling according to operational rules.

Can I use Obsidian to manage API design documentation and ensure standard compliance?

Yes, you can use Obsidian to manage API design documentation because this Skill generates and updates detailed design documents adhering to Obsidian operational standards and mandatory frontmatter keys.

How do I draft an API design document for idempotency and error handling after a basic design change?

Draft an API design document for idempotency and error handling after a basic design change by using this Skill to focus on processing flows and constraints, ensuring the revision aligns with OpenAPI specifications.

Does this API documentation generator support Zod and Hono frameworks?

Yes, the API documentation generator supports Zod and Hono frameworks, incorporating these technical specifications into the detailed design document generation process for input validation and routing constraints.