doc-bd-api
CommunityGenerate BD-API docs per diopside rules
Authortsuji-tomonori
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill automates the creation and revision of API Basic Design (BD) documents, ensuring they adhere to the specific conventions and requirements of the diopside project.
Core Features & Use Cases
- API Specification Generation: Creates or updates API interface contracts (endpoints, inputs, outputs, auth, errors) following diopside's Obsidian-based documentation standards.
- Compliance Enforcement: Ensures adherence to frontmatter requirements, naming conventions, and content guidelines for BD-phase API documentation.
- Use Case: When a new API endpoint needs to be designed or an existing one modified, this Skill guides the user to generate a compliant BD document, including detailed specifications for request/response schemas, error handling, and versioning.
Quick Start
Use the doc-bd-api skill to create a new BD-API document for the '/users' endpoint.
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-bd-api Download link: https://github.com/tsuji-tomonori/diopside-v3/archive/main.zip#doc-bd-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.