doc-bd-api

Generate and revise API Basic Design documents following diopside project conventions.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

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.

Frequently Asked Questions about doc-bd-api

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

FAQPage Schema
How do I generate API Basic Design documentation using Obsidian and Hono?

To generate API Basic Design documentation, define endpoints, request/response contracts, and error handling. This Skill automates creating BD documents using Obsidian standards and Hono guidelines.

What is an API Basic Design document and what should it include?

An API Basic Design document specifies endpoints, inputs, outputs, authentication, error handling, and versioning. It uses YAML frontmatter for metadata and Markdown for operational instructions.

Can I use Zod to define request and response schemas in my API design?

Yes, you can use Zod to define request and response schemas. The Skill enforces compliance with Hono and Zod implementation guidelines for API specifications.

How do I ensure my API documentation follows diopside project conventions?

To ensure your API documentation follows diopside conventions, enforce frontmatter requirements, naming conventions, and content guidelines. This Skill automates adherence to these specific standards.

What is the best way to revise existing API specifications in Obsidian?

The best way to revise existing API specifications is updating Markdown operational instructions and YAML frontmatter. This Skill automates revisions while enforcing Obsidian documentation standards.