skills.rest
castrojo
castrojoCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

architecture

Create or update ARCHITECTURE.md documenting design, components, data flow, and dependencies.

2|Updated Mar 4, 2026
Search Tags:#design#architecture#documentation#components#dependencies#cncf
One-click install
npx skills add https://github.com/castrojo/cncf-skills --skill architecture-castrojo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: architecture
Source: https://github.com/castrojo/cncf-skills/tree/main/skills/architecture
Command: npx skills add https://github.com/castrojo/cncf-skills --skill architecture-castrojo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps create or update the ARCHITECTURE.md file, ensuring a clear and comprehensive technical overview of a CNCF project for contributors and reviewers.

Core Features & Use Cases

  • Architecture Documentation: Generates or updates ARCHITECTURE.md with components, data flow, dependencies, and design decisions.
  • Use Case: A project is preparing for graduation and needs a detailed architecture document to satisfy CNCF requirements. This Skill guides the maintainer through documenting all essential aspects.

Quick Start

Use the architecture skill to create or update the ARCHITECTURE.md file for this project.

Frequently Asked Questions about architecture

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

FAQPage Schema
How do I document project architecture and design decisions for new contributors?▼

To document project architecture, generate or update an ARCHITECTURE.md file detailing components, data flow, dependencies, and key design decisions. This provides a comprehensive technical overview for new contributors and security reviewers.

What should be included in an architecture document for a CNCF project graduation review?▼

An architecture document for CNCF graduation should include subsystem identification, component descriptions, data flow diagrams, deployment models, external dependencies, and extension points. Recording design rationales ensures the technical overview satisfies review requirements.

Can I update an existing ARCHITECTURE.md or do I need to create it from scratch?▼

You can update an existing ARCHITECTURE.md or create a new one. The process identifies missing subsystems, draws updated diagrams, describes components, and documents data flow and dependencies to ensure the architecture documentation remains current.

What is the best way to describe data flow and external dependencies in technical documentation?▼

The best way to describe data flow and external dependencies in technical documentation is to systematically identify subsystems, map component interactions, and detail the deployment model. Recording extension points and design rationales provides essential context.

Does this approach work for projects that currently lack any technical overview documentation?▼

Yes, this approach works for projects lacking technical overview documentation by guiding maintainers through identifying subsystems, drawing diagrams, and describing components. It builds a complete architecture document from the ground up.

Related Skills

Explore More Software Engineering Skills→
Hypercart-Dev-ToolsHypercart-Dev-Tools
2

Architectural Baseline Diagnoser

Diagnose a repository's architectural style by analyzing dependency manifests, directory structures, and code patterns.

Official
Intermediate
PedroGiudicePedroGiudice
5

architecture-diagram-creator

Generate HTML architecture diagrams with data flows and deployment layers.

Community
Advanced
adityasingh2400adityasingh2400
2

document-release

Cross-reference shipped diffs and update Markdown project documentation.

Community
Advanced
insightwavesmithinsightwavesmith

code-analyzer

Analyze code changes to identify those meeting evidence-shape-check criteria.

Community
Intermediate