documenting-domains

Name: documenting-domains
Availability: InStock
Author: thkt

Generate domain documentation with entity glossaries and Mermaid diagrams from codebase analysis.

11|1|Updated Aug 6, 2025

Search Tags:#use cases #glossary #entities #ER diagram #domain understanding

Ready to run

npx skills add https://github.com/thkt/claude-config --skill documenting-domains

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documenting-domains
Source: https://github.com/thkt/claude-config/tree/main/ja/skills/documenting-domains
Command: npx skills add https://github.com/thkt/claude-config --skill documenting-domains

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

ドメインのエンティティ、用語、関係、ユースケースを自動で抽出し、統合ドキュメントを生成します。

Core Features & Use Cases

エンティティ/モデルの抽出
ドメイン用語の抽出と用語集生成
概念関係図(Mermaid ER図)の生成
ユースケース/サービスの抽出

Quick Start

「ドメイン理解を生成して」と言うと、ドメイン理解ドキュメントが作成されます。

Frequently Asked Questions about documenting-domains

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

FAQPage Schema

How do I automatically extract entities and relationships from my codebase?▼

This Skill automates entity extraction from TypeScript, JavaScript, and Python codebases by analyzing class definitions, interfaces, dataclasses, and ORM models (Prisma, TypeORM, SQLAlchemy). It maps entity relationships through import analysis and generates Markdown documentation with Mermaid ER diagrams showing how entities connect.

Can I generate a domain glossary from my code automatically?▼

Yes. The Skill decomposes entity and model names into domain terms, then generates a comprehensive glossary document. It extracts meaningful terminology from your codebase structure, creating a shared vocabulary reference for your domain without manual compilation.

What's the best way to document domain understanding across multi-language projects?▼

This Skill handles multi-language codebases by analyzing both TypeScript/JavaScript and Python simultaneously. It produces unified domain documentation with entity glossaries, relationship diagrams, and use-case mappings in a single integrated output, eliminating separate documentation per language.

Does this work with ORMs like Prisma, TypeORM, and SQLAlchemy?▼

Yes. The Skill specifically analyzes ORM and database models from Prisma, TypeORM, and SQLAlchemy schemas. It identifies entities and their relationships directly from ORM definitions, producing accurate domain diagrams and glossaries without manual model mapping.

How do I create ER diagrams that show my domain model relationships?▼

The Skill automatically generates Mermaid ER diagrams by analyzing entity references and imports across your codebase. It produces visual relationship diagrams that map how entities connect, eliminating manual diagram creation and keeping documentation synchronized with code changes.

Can I extract use cases and services from my codebase structure?▼

Yes. The Skill analyzes your codebase to identify and extract use cases and services alongside entities. It maps how domain concepts relate to application behaviors, producing documentation that bridges code structure and business logic in a single domain document.