skills.rest
generic-automation-and-it
generic-automation-and-itOFFICIAL
Explore all skills by this author →
GitHub

create-hld

Authors design-only High-Level Design folders with README, LADRs, NFRs, and C4 diagrams.

Updated Jul 23, 2026
Search Tags:#architecture#documentation#adr#scaffolding#hld#high-level design#c4 diagram
One-click install
npx skills add https://github.com/generic-automation-and-it/smooth-ai-stockanalysis --skill create-hld-generic-automation-and-it
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-hld
Source: https://github.com/generic-automation-and-it/smooth-ai-stockanalysis/tree/main/.agents/skills/create-hld
Command: npx skills add https://github.com/generic-automation-and-it/smooth-ai-stockanalysis --skill create-hld-generic-automation-and-it

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve? Writing a High-Level Design document from scratch is slow and inconsistent — teams skip decisions, write vague quality requirements, or mix implementation plans into design docs. This Skill scaffolds and guides the authoring of a structured, design-only HLD folder so every design captures intent, decisions, and measurable quality bars the same way. ## Core Features & Use Cases - Deterministic scaffolding: A bash script creates docs/hlds/NNN-<slug>/ with auto-incremented numbering, placeholder-substituted templates for README, AGENTS.md, C4 context diagram, LADR, and NFR files. - Guided authoring workflow: Multi-phase process covering scope clarification, strategic and tactical LADRs, measurable NFRs, and diagram selection beyond the mandatory C1 System Context. - Design-only guardrails: Enforces no implementation plans, no code outside examples/, and an AGENTS.md without architecture sections. - Use Case: An engineer starting a new payments platform initiative runs the skill to scaffold docs/hlds/003-payments-platform/, then drafts LADRs for key decisions and NFRs with measurable latency targets before any code is written. ## Quick Start Ask the AI to create a high-level design for your initiative, for example: run /create-hld payments-platform and follow the clarification and drafting workflow.

Frequently Asked Questions about create-hld

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

FAQPage Schema
How do I create a High-Level Design document for a new project?▼

Invoke the skill with a kebab-case slug, such as /create-hld payments-platform. The scaffold script creates docs/hlds/NNN-<slug>/ with README, AGENTS.md, diagrams, ladrs, and nfrs folders, then you follow the guided workflow to draft intent, decisions, and NFRs.

What should a High-Level Design document include?▼

This HLD structure includes a README with intent and key goals with acceptance criteria, one LADR file per architectural decision, one NFR file per measurable quality attribute, and a mandatory C1 System Context Mermaid diagram. Implementation plans and code are explicitly excluded.

What is the difference between strategic and tactical LADRs?▼

Strategic LADRs (numbered first) capture what is being built and why, while tactical LADRs capture how it will be executed, such as runtime, protocol, or config choices. Tactical LADRs are numbered after strategic ones and existing numbers are never renumbered.

Does the scaffold script work with agents other than Claude Code?▼

Yes. The scripts use only bash and coreutils and discover the repo root via git rev-parse, so Codex, Copilot, and Cursor run them identically. The AGENTS.md quality rules ship inside the skill via hld-agents-rules.sh for agents that do not run Claude Code hooks.

When should I not use a design-only HLD?▼

Do not use it for implementation planning, execution phasing, or sub-issue breakdown — those belong in the issue or work tracker. The HLD is strictly for discovery and prototyping, capturing intent, decisions, and quality bars before build work starts.

Related Skills

Explore More Software Engineering Skills→
Owl-ListenerOwl-Listener
2.0k

design-brief

Define and document a design brief with problem space, audience, constraints, and success criteria.

Community
Intermediate
arthur-debertarthur-debert

to-tickets

Break specs and ADRs into epic and work stream tracker issues.

Community
Advanced
atomicinnovationatomicinnovation
30

review-adr

Review ADR YAML frontmatter and enforce lifecycle status transitions.

Official
Advanced
nevesbnevesb

quick-design

Draft lightweight design specs for small gameplay changes with acceptance criteria.

Community
Intermediate