describe-design

Generate markdown architecture documents with Mermaid diagrams and code references.

Updated Feb 15, 2025
One-click install
npx skills add https://github.com/Ciabatos/sybath --skill describe-design-ciabatos
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: describe-design
Source: https://github.com/Ciabatos/sybath/tree/main/.opencode/skills/describe-design
Command: npx skills add https://github.com/Ciabatos/sybath --skill describe-design-ciabatos

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the process of researching and documenting codebase architecture, making complex systems understandable for both humans and AI agents.

Core Features & Use Cases

  • Codebase Exploration: Scans directory structures, READMEs, and configuration files to build a mental model.
  • Architectural Documentation: Generates markdown documents with Mermaid diagrams and stable code references.
  • Use Case: Onboarding new developers by providing clear documentation of a system's design, or generating an overview of a new feature's architecture.

Quick Start

Use the describe-design skill to document the architecture of the 'user-authentication' feature.

Frequently Asked Questions about describe-design

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

FAQPage Schema
How do I generate architecture documentation with Mermaid diagrams for my codebase?

To generate architecture documentation, this Skill scans your codebase structure, identifies dependencies, and outputs markdown documents containing Mermaid diagrams and stable code references. It automates the research process to make complex systems understandable.

What is the best way to document code architecture for developer onboarding?

Documenting code architecture for onboarding is best handled by automating architectural overviews. This Skill explores your directory structures and configuration files, generating clear markdown documentation suitable for both human and AI consumption.

Can I scope architectural documentation to a specific feature rather than the whole codebase?

Yes, you can scope architectural documentation to specific features or systems. The Skill scopes its research based on user-defined parameters, exploring only the relevant codebase structure to draft targeted architectural overviews.

How does codebase exploration work when generating knowledge transfer documents?

Codebase exploration for knowledge transfer works by scanning directory structures, READMEs, and configuration files. The Skill builds a mental model of your system, identifies interactions, and drafts architectural overviews with Mermaid diagrams.

Does this architectural documentation approach work without external dependencies?

Yes, this architectural documentation approach works without external dependencies. The Skill operates independently to research your codebase, identify dependencies and interactions, and generate markdown documents.

What format are the architectural overviews output in for AI consumption?

Architectural overviews are output as markdown documents containing Mermaid diagrams and stable code references. This format ensures the generated architectural documentation is suitable for both human reading and AI agent consumption.