nw-design

Generate C4 diagrams and architecture decision records for system design.

Updated Mar 18, 2024
One-click install
npx skills add https://github.com/v1bh0r/precise-ledger-pro --skill nw-design-v1bh0r
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: nw-design
Source: https://github.com/v1bh0r/precise-ledger-pro/tree/main/nWave/skills/nw-design
Command: npx skills add https://github.com/v1bh0r/precise-ledger-pro --skill nw-design-v1bh0r

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Plans and documents software architecture by generating C4 diagrams and guiding technology selection, helping teams define component boundaries and communicate architecture decisions.

Core Features & Use Cases

  • Produces C4 System Context, Container, and Component diagrams (Mermaid) to visualize architecture.
  • Guides technology stack decisions and creates architecture documentation for new or evolving systems.
  • Use Case: When starting a new project, outline the target architecture and decision rationale for stakeholders.

Quick Start

Design the architecture for a target system and generate diagrams and a rationale in one flow.

Frequently Asked Questions about nw-design

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

FAQPage Schema
How do I generate C4 diagrams for software architecture documentation?

You can generate C4 diagrams by defining component boundaries and producing System Context, Container, and Component diagrams using Mermaid to visualize architecture. This approach helps document architecture decisions and communicate system design to stakeholders.

What is the best way to document architecture decisions and technology selection rationale?

Documenting architecture decisions involves generating Architecture Decision Records (ADRs) with clear rationale alongside technology selection. This ensures that component boundaries and open-source evaluation choices are communicated effectively for new or evolving systems.

Can I use Mermaid to create System Context and Container diagrams for a new project?

Yes, you can use Mermaid to create System Context and Container diagrams for a new project. This visualizes the target architecture and outlines the decision rationale required by stakeholders when planning software architecture.

How do I evaluate open-source options when defining system architecture?

Evaluating open-source options during system architecture design involves guiding technology stack decisions and generating documentation. This process helps define component boundaries and records the evaluation rationale within relevant ADRs.

Does this approach support documenting architecture for evolving systems?

Yes, documenting architecture for evolving systems is supported by generating C4 diagrams and guiding technology selection. It applies when defining component boundaries and evaluating open-source options for new or continuously changing systems.

When do I need to generate C4 diagrams and ADRs for my system?

You need to generate C4 diagrams and ADRs when defining component boundaries, evaluating open-source options, and documenting architecture decisions for new or evolving systems. This satisfies the requirement to produce a System Context diagram and relevant rationale.