Technical documentation
Skill pngdeity/apm-user-repository/packages/technical-documentation/.apm/skills/technical-documentation
Comprehensive guidance for writing architectural and technical documentation. Use when the user asks to create or update Architecture Decision Records (ADRs) or Technical Design Documents (Micro-Leaves).From its SKILL.md
npx -y skills add pngdeity/apm-user-repository --skill technical-documentationAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
1.4 KB, 238 tokens by cl100k_base, as published. Nobody here has run it
Technical Documentation (ADRs & Design Leaves)
This project maintains a strict hierarchy of technical documentation to ensure architectural integrity and implementation reliability.
1. Architectural Decisions (ADRs)
Use this workflow when making high-level technology choices, defining system patterns, or establishing project-wide constraints.
- Workflow & Template: Refer to references/adrs.md
- Key Focus: Rationale, alternatives considered, and long-term consequences.
2. Technical Implementation (Micro-Leaves)
Use this workflow when designing atomic units of logic, defining interface contracts, or mapping out failure modes before writing code.
- Workflow & Template: Refer to references/design.md
- Key Focus: Interface contracts, blast radius isolation, and failure-mode resilience.
3. Documentation Philosophy
- ADRs first: Define the "Why" and the "What" at the system level.
- Leaves second: Define the "How" for each atomic unit of that decision.
- Code third: Implement only after the interface and failure modes are approved.
What ships with it: 2 files
10.6 KB alongside SKILL.md