skills.rest
Atemndobs
AtemndobsCOMMUNITY
Explore all skills by this author →
𝕏@Atemkeng5GitHub

architecture-docs

Automates architecture documentation with Mermaid diagrams and templates for common diagram types.

Updated May 31, 2025
Search Tags:#architecture#documentation#mermaid#flowchart#diagram#erd
One-click install
npx skills add https://github.com/Atemndobs/nebula-rfp --skill architecture-docs-atemndobs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: architecture-docs
Source: https://github.com/Atemndobs/nebula-rfp/tree/main/.gemini/skills/architecture-docs
Command: npx skills add https://github.com/Atemndobs/nebula-rfp --skill architecture-docs-atemndobs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Standardized, maintainable architecture documentation is hard to keep up-to-date across teams. This skill provides a structured approach to document systems using Mermaid diagrams, empowering teams to produce clear, reusable diagrams and keep documentation in sync with implementation plans.

Core Features & Use Cases

  • Mermaid Diagram Best Practices: clear rules for labeling and escaping special characters to guarantee diagrams render correctly.
  • Flowchart Template: canonical flow representations for data and control flows.
  • Sequence Diagram Template: lifecycle and interaction sequences across components.
  • Entity Relationship Diagram Template: data model visualization for relational structures.
  • State Diagram Template: process and state transitions for system behaviors.
  • Documentation Structure: guidance for implementation plans and structured docs under docs/implementation-plan/ and related feature docs.
  • ASCII Diagrams: lightweight alternatives for quick, text-based diagrams.

Quick Start

Create your first architecture diagram in your docs/architecture/ directory using Mermaid.

Frequently Asked Questions about architecture-docs

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

FAQPage Schema
How do I create maintainable architecture documentation with Mermaid diagrams?▼

To create maintainable architecture documentation with Mermaid, use structured templates for flowcharts and sequence diagrams. This provides clear rules for labeling, escaping special characters, and organizing implementation plans to keep docs in sync with code.

What is the best way to visualize data models and system flows in technical docs?▼

The best way to visualize data models and system flows in technical docs is using standardized Mermaid templates. Entity relationship diagrams map relational structures, while flowcharts provide canonical representations for data and control flows across components.

Can I use ASCII diagrams instead of Mermaid for quick architecture documentation?▼

Yes, you can use ASCII diagrams as lightweight alternatives for quick, text-based architecture documentation. They provide fast visualization without rendering dependencies, complementing the standard Mermaid diagram templates available for more complex system behaviors.

Does this approach support sequence and state diagrams for component interactions?▼

Yes, this approach supports sequence and state diagrams for component interactions. Sequence diagrams map lifecycle and interaction sequences across components, while state diagrams visualize process and state transitions for specific system behaviors.

Why do my Mermaid diagrams fail to render correctly in architecture docs?▼

Mermaid diagrams fail to render correctly in architecture docs due to improper labeling and unescaped special characters. Following established best-practice labeling guidance and escaping rules guarantees diagrams render correctly across all templates.

Related Skills

Explore More Software Engineering Skills→
ThalesGroupThalesGroup
19

advanced-svg-system-design

Define SVG diagram systems with grid rules, component taxonomy, and color semantics.

Official
Advanced
musingfoxmusingfox
2

doc-render-beauty

Convert Markdown documents into HTML pages with pre-rendered Mermaid diagrams.

Community
Advanced
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic
chloebrettchloebrett
3

diagrams

Generate system architecture, process flow, and data relationship diagrams from textual descriptions.

Community
Intermediate