skills.rest
avvale
avvaleOFFICIAL
Explore all skills by this author →
WebsiteGitHub

aurora-context-generator

Generate CONTEXT.md documentation from code and YAML definitions.

Updated Jan 26, 2023
Search Tags:#typescript#code analysis#documentation#software architecture#yaml#bounded context#context generation
One-click install
npx skills add https://github.com/avvale/aurora-back --skill aurora-context-generator
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: aurora-context-generator
Source: https://github.com/avvale/aurora-back/tree/main/.claude/skills/aurora-context-generator
Command: npx skills add https://github.com/avvale/aurora-back --skill aurora-context-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) components.

What problem does it solve?

This Skill automates the generation of documentation for bounded contexts by analyzing existing code and YAML definitions, reducing manual documentation effort and ensuring accuracy.

Core Features & Use Cases

  • Code-to-Documentation: Explores code structure (.aurora.yaml, API resolvers, application handlers, domain logic) to infer context purpose, modules, business rules, and flows.
  • Automated CONTEXT.md Generation: Creates or updates CONTEXT.md files for bounded contexts.
  • Use Case: When a new bounded context is developed or an existing one needs updating, this Skill can be invoked to generate a comprehensive CONTEXT.md file, capturing its essential details from the codebase.

Quick Start

Use the aurora-context-generator skill to document the bounded context named 'order-management'.

Frequently Asked Questions about aurora-context-generator

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

FAQPage Schema
How do I generate documentation for bounded contexts automatically?▼

Automate bounded context documentation by analyzing code and YAML definitions to infer modules and business rules, creating a comprehensive CONTEXT.md file. It extracts context purpose and flows directly from the codebase.

What is the best way to document software architecture from existing TypeScript code?▼

Document software architecture by exploring application handlers and domain logic to infer business rules, then automatically generating a CONTEXT.md file that captures essential architectural details from the TypeScript codebase.

How does automated context generation work with YAML definitions?▼

Automated context generation works by exploring `.aurora.yaml` files to identify modules and aggregates, then mapping these definitions against API resolvers and application logic to produce a detailed CONTEXT.md document.

Can I use aurora-context-generator to document an existing bounded context?▼

Yes, you can document an existing bounded context by analyzing its current API definitions and application logic, then updating the CONTEXT.md file to reflect the latest code-driven architecture.

Do I need specific directory structures for code-driven documentation of bounded contexts?▼

Yes, code-driven documentation requires specific directory structures: `cliter/{context}/*.aurora.yaml` for modules, `src/@api/{context}/` for API definitions, and `src/@apps/{context}/` for application logic.

Why does my generated CONTEXT.md not capture all software architecture flows?▼

Generated CONTEXT.md files may miss architecture flows if the bounded context lacks proper YAML definitions, or if API resolvers and domain rules are missing from the expected `src/@api/{context}/` and `src/@apps/{context}/` directories.

Related Skills

Explore More Software Engineering Skills→
OreStudioOreStudio
25

ores-http-recipes

Compare API route definitions against HTTP recipe documentation to detect mismatches.

Official
Intermediate
safety-quotient-labsafety-quotient-lab
18

cycle

Update project markdown files and commit changes to Git.

Official
Advanced
PlebeianAppPlebeianApp
9

domain-driven-design

Apply bounded contexts, aggregates, and ubiquitous language to model software architecture.

Official
Advanced
isiouisiou

code-documentation-doc-generate

Generate API references, architecture diagrams, READMEs, and user guides from source code.

Community
Advanced