Stats
Actions
Tags
From velith
Provides patterns for writing technical books: concept progression, code block rules, diagrams, API reference format, and lab design.
How this skill is triggered — by the user, by Claude, or both
Slash command
/velith:book-technicalThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
**Progression**: Part1 Intro(15%) → Part2 Foundations(25%) → Part3 Practice(30%) → Part4 Advanced(20%) → Part5 Reference(10%). Novice(what?) → Competent(how?) → Expert(why?).
Progression: Part1 Intro(15%) → Part2 Foundations(25%) → Part3 Practice(30%) → Part4 Advanced(20%) → Part5 Reference(10%). Novice(what?) → Competent(how?) → Expert(why?).
Chapter: Hook(problem scenario) → Concept(linked to prior) → Code(minimal runnable) → Explanation(line-by-line) → Pitfalls(2-3 beginner mistakes) → Summary + preview.
Code rules: language tag always · runnable only (pseudocode labeled) · include imports · show expected output · filename as title. Beginner: 10-30 lines, Intermediate: 30-80, Advanced: 80-200.
Diagrams: architecture (boxes+arrows), flowchart (Mermaid TD), sequence (Mermaid sequenceDiagram), comparison (markdown table). Pair ASCII + Mermaid for EPUB/PDF compat. ≤3/chapter.
API reference: functionName(params) → one-liner → Parameters table → Returns type → Example code → See also.
Version-independent writing: prefer "Save the file" over "Click File > Save". Exception: security/breaking changes need specific versions.
Labs: objective → prerequisites → steps with verification → result check → challenge. Easy(step-by-step, 3-5), Medium(hints, 5-8), Hard(goal-only, 3-5). Parts 1-2 Easy, Part 3 Medium, Part 4 Hard.
npx claudepluginhub epicsagas/plugins --plugin velithGenerates comprehensive technical documentation from codebases by analyzing architecture, design patterns, and implementation details into long-form manuals and ebooks.
Drafts READMEs, API docs, tutorials, release notes, and reviews technical docs for clarity and structure. Activates on docs/ .md files and READMEs.
Clear technical documentation, API docs, architecture decision records, and runbooks.