Marketplace

documenting-domains

Generate domain understanding documentation from codebase analysis. Extracts entities, business logic, domain terms, and concept relationships. Triggers: domain understanding, glossary, entities, business logic, domain model, ER diagram, use cases.

allowed_tools: Read, Write, Grep, Glob, Bash, Task

$ 安裝

git clone https://github.com/thkt/claude-config /tmp/claude-config && cp -r /tmp/claude-config/skills/documenting-domains ~/.claude/skills/claude-config

// tip: Run this command in your terminal to install the skill


name: documenting-domains description: > Generate domain understanding documentation from codebase analysis. Extracts entities, business logic, domain terms, and concept relationships. Triggers: domain understanding, glossary, entities, business logic, domain model, ER diagram, use cases. allowed-tools:

  • Read
  • Write
  • Grep
  • Glob
  • Bash
  • Task context: fork

docs:domain - Domain Understanding Generation

Auto-generate domain documentation from codebase analysis.

Detection Items

CategoryTargets
Entities/Modelsclass, interface, dataclass, Pydantic, Prisma, TypeORM, SQLAlchemy
Domain TermsClass/function names, comments, JSDoc, docstrings
RelationshipsEntity references, inheritance, import analysis
Use CasesService/UseCase classes, Handler/Controller functions

Analysis Scripts

ScriptPurpose
scripts/extract-entities.shEntity name, fields, relationships
scripts/extract-glossary.shTerms, frequency, context
scripts/generate-er-diagram.shMermaid ER diagram

Generated Structure

# Domain Understanding Document

## Entity List

### User

- id: string
- name: string
  Related: Order, Profile

## Concept Relationship Diagram

(Mermaid ER diagram)

## Domain Glossary

| Term | Description | Related |

## Use Case List

| Use Case | Description | Entities |

Usage

/docs:domain              # Generate domain docs
"Generate domain glossary" # Natural language

Markdown Validation

After generation, validate output with:

~/.claude/skills/scripts/validate-markdown.sh {output-file}

Non-blocking (warnings only) - style issues don't block document creation.

References

  • Related: documenting-architecture, documenting-apis, setting-up-docs