Architecture Md Builder

What it does

The architecture-md-builder skill generates Markdown documents describing software architectures. It takes a high-level description of an architecture as input and produces a structured document with sections like components, relationships, and technology choices. This allows for clear documentation and communication of complex system designs.

When to use it

• Documenting the design of a new microservices application.
• Creating architectural overviews for existing systems needing better clarity.
• Generating initial drafts of architecture decision records (ADRs).
• Producing technical documentation for onboarding new team members.
• Formalizing informal discussions about system structure into written specifications.

Key capabilities

• Generates Markdown documents.
• Creates sections for components, relationships, and technologies.
• Accepts high-level architectural descriptions as input.
• Produces structured architecture documentation.

Example prompts

• "Describe the architecture of an e-commerce platform with microservices for product catalog, order management, and payment processing."
• "Generate a Markdown document outlining the architecture for a serverless data pipeline using AWS Lambda and S3."
• “Create an architectural overview for a mobile app that uses Firebase for authentication and real-time database.”

Tips & gotchas

The quality of the generated documentation depends heavily on the clarity and detail provided in the initial description. Providing specific details about components and their interactions will yield more useful results.