architecture-doc-creator_skill

Overview

This skill automates creation of architecture documentation for software systems, producing structured, production-ready artifacts. It guides writers and engineers through patterns, templates, and validations to ensure consistent, maintainable architecture docs. Use it to speed documentation, enforce standards, and generate config or sample code where needed.

How this skill works

The skill listens for triggers like "architecture doc creator" and runs a guided workflow that captures system goals, components, data flows, and constraints. It produces templates (diagrams, component descriptions, deployment patterns), sample configuration or code snippets, and validates outputs against common documentation standards. Outputs include ready-to-publish Markdown, diagrams (text-first formats), and recommendations for follow-up sections.

When to use it

• You need a complete architecture document for a new feature, service, or system
• You want to convert design notes into a standardized architecture spec
• You need example configs, deployment patterns, or sample code tied to the architecture
• You want to validate an existing architecture doc against common standards
• You need repeatable templates for team-wide documentation practices

Best practices

• Start with high-level goals, constraints, and success criteria before detailing components
• Use modular sections: overview, components, interfaces, data flow, security, and operations
• Include diagrams in text-first formats (Mermaid, PlantUML) so they are versionable and editable
• Provide minimal runnable examples or configs to clarify deployment and integration
• Run validation checks against required fields and update docs iteratively with implementation feedback

Example use cases

• Generate an architecture spec for a microservices-based payment system with diagrams and deployment notes
• Translate whiteboard designs into a structured document with component responsibilities and API contracts
• Create a template for onboarding new services that covers monitoring, backups, and security controls
• Validate an existing architecture doc to find missing operational requirements or security considerations
• Produce sample IaC snippets and configuration examples tied to architecture decisions