generic-automation-and-it/smooth-ai-stockanalysis / .agents/skills/create-hld
create-hld
VerifiedInvoke to author a High-Level Design (HLD) at discovery / prototyping phase. Design-only: delivers intent + spec for AI and humans to build against — no implementation plan, no code outside examples/. Trigger keywords: "HLD", "high level design", "design doc", "architecture design", "create a design". Also triggers on /create-hld.
| File | Kind | Size |
|---|---|---|
| AGENTS.md | markdown | 2.4 KB |
| SKILL.md | skill md | 6.5 KB |
| agents/openai.yaml | config | 360 B |
| assets/AGENTS.template.md | markdown | 1.3 KB |
| assets/LADR.template.md | markdown | 1.1 KB |
| assets/NFR.template.md | markdown | 1.1 KB |
| assets/README.template.md | markdown | 2.1 KB |
| assets/c4-context.template.md | markdown | 2.0 KB |
| assets/examples.README.template.md | markdown | 505 B |
| references/diagram-selection.md | markdown | 2.2 KB |
| references/status-vocabulary.md | markdown | 1.6 KB |
| scripts/hld-agents-rules.shexecutable | script | 3.3 KB |
| scripts/scaffold-hld.shexecutable | script | 4.7 KB |
scripts/hld-agents-rules.sh
View on GitHub#!/usr/bin/env bash
# Skill: create-hld
# Emits the compacted quality rules for an HLD-folder AGENTS.md.
#
# This is the HLD VARIANT of the general AGENTS.md rules. It deliberately OMITS
# the System Context / C4 / architecture-diagram section, because in an HLD the
# architecture lives in diagrams/ (driven by SKILL.md), never in AGENTS.md.
#
# Shipped inside the skill so it is self-contained across agents: Codex and
# other tools that do not run Claude Code hooks can still read these rules by
# executing this script. The repo's global knowledge-rule-enforce.sh hook
# remains the enforcer for general (non-HLD) AGENTS.md files.
set -euo pipefail
cat <<'EOF'
HLD AGENTS.md Quality Rules (design-only variant — NO architecture section)
The AGENTS.md at the root of an HLD folder is the AI-coder context document.
Architecture diagrams belong in diagrams/, NOT here. Apply these rules:
## Required Structure (in order — omit any empty section except Changelog)
1. H1 + first line: "# AGENTS.md - <Initiative>" then "AI Context: HLD for <name>. Updated: YYYY-MM-DD"
2. TL;DR — One line: what this HLD covers + where intent (README), decisions (ladrs/), and quality spec (nfrs/) live.
3. Non-Negotiables — Only things an AI coder building against this design would plausibly get wrong. Examples:
- "Do not collapse <X> into <Y> — the split is intentional (LADR-NN)."
- "LADRs are Draft/Prototype — flag deviations, do not silently override."
4. Architecture Decisions — Table summarising LADRs an AI coder must respect.
Columns: | LADR | Decision | Why it matters |. Link to ./ladrs/ once. Only LADRs whose violation produces wrong code.
5. Key Behaviors — Non-obvious runtime/operational truths not apparent from a design read.
6. Quality Constraints — Pointer to ./nfrs/ + any feature-specific constraint that changes how code is written. No measurable targets duplicated from NFR files.
7. Migration Plans — Planned splits/deprecations the design implies. Omit if none.
8. Changelog — Always present. Format: | Date | Change | Ref |
## Explicitly DO NOT include
- A System Context / C4Context / sequence / ER diagram section — diagrams live in diagrams/.
- Any code or code snippets — those live in examples/ only.
- Implementation plans, phasing, or execution sequencing — out of HLD scope (tracked in the issue/work tracker).
## Value Test — apply to every line; if NONE apply, remove it:
1. Bug prevention: Would an AI coder build worse against this design without it?
2. Decision quality: Would an AI coder make a worse architectural choice without it?
3. System understanding: Does it reveal a boundary/constraint not in README, ladrs/, nfrs/, or diagrams/?
## Anti-Patterns (MUST remove)
- Empty sections with "N/A"/"None" — omit entirely.
- (src: path) annotations or file listings as "components".
- Restating the README's intent/goals — AGENTS.md is guardrails, not narrative.
- Duplicating LADR prose or NFR targets — link/summarise instead.
- Generic boilerplate (e.g. "required env vars: ...").
- Business value / problem-solution-impact blocks (those belong in README.md).
## Drift Minimization
- If a design change alters documented behaviour/decisions, update AGENTS.md in the same change.
- Every update adds a Changelog row. Stale context is worse than no context.
EOF
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |