30
GitHub Stars
1
Bundled Files
2 months ago
Catalog Refreshed
3 months ago
First Indexed
Readme & install
Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.
Installation
Preview and clipboard use veilstrat where the catalogue uses aiagentskills.
npx veilstrat add skill mcouthon/agents --skill architecture- SKILL.md4.2 KB
Overview
This skill guides high-level architecture documentation and system-structure analysis. It emphasizes interfaces, data flows, integration points, key design decisions, and failure modes while avoiding implementation details. Use it to create diagrams, API contracts, and concise architectural overviews for teams and stakeholders.
How this skill works
The skill inspects system boundaries, components, public interfaces, and major data flows to produce a concise architecture overview. It outputs component responsibilities, interface contracts, integration points, and identified failure surfaces, and recommends mermaid-style diagrams and API contract sketches. It intentionally omits low-level implementation specifics and algorithmic details.
When to use it
- Document a new system’s high-level design for onboarding or handoff
- Create component and sequence diagrams to communicate structure
- Analyze integration points and external system contracts
- Summarize key design decisions and tradeoffs for architecture reviews
- Identify likely failure modes and where to add resilience
Best practices
- Describe components by responsibility, not by internal code or functions
- Show data movement with diagrams (component and sequence) rather than step-by-step code
- Specify public APIs and data contracts crossing boundaries
- Call out error surfaces and recovery strategies explicitly
- Record rationale and tradeoffs for each major decision
Example use cases
- Produce an architecture overview for a microservices-based order processing system
- Define API contracts and data flow for a public-facing HTTP service
- Map integration with third-party auth, payments, and storage systems
- Draft a sequence diagram showing a client request through API → service → datastore
- List key reliability concerns and mitigation strategies before a production rollout
FAQ
Include components, interfaces, data flows, contracts, and failure modes. Avoid implementation specifics such as code, variable names, or internal algorithms.
Should I include diagrams?
Yes. Component and sequence diagrams communicate structure clearly. Use simple mermaid-style diagrams to illustrate flows and interactions.