doc-dd-api
CommunityGenerate API design docs with diopside rules.
Authortsuji-tomonori
Version1.0.0
Installs0
System Documentation
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'.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: doc-dd-api Download link: https://github.com/tsuji-tomonori/diopside-v3/archive/main.zip#doc-dd-api Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.