avav25/docs-pack
plugin/skills/docs-pack/SKILL.md
Use this skill when onboarding users to a feature, producing API documentation, or writing operational procedures — to generate a user-facing documentation pack (README, API reference, runbook, tutorial) for a module or feature; distinct from the `docs` knowledge skill — `docs-pack` produces git-versioned user docs while `docs` is general documentation guidance.
$ install --global
skillsauthnpx skillsauth add avav25/ai-assets docs-packInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: May 23, 2026, 4:33 AM138.5s5 files scanned
SKILL.md
- name:
- docs-pack
- description:
- Use this skill when onboarding users to a feature, producing API documentation, or writing operational procedures — to generate a user-facing documentation pack (README, API reference, runbook, tutorial) for a module or feature; distinct from the `docs` knowledge skill — `docs-pack` produces git-versioned user docs while `docs` is general documentation guidance.
- context:
- fork
- argument-hint:
- <path> [--template api-reference|user-guide|runbook|architecture] [--audience developer|operator|user]
/docs-pack — User-Facing Documentation Pack
Generate a coherent set of user-facing docs for a module or feature. Output goes to <repo>/docs/<module>/ (versioned in git, NOT in .ai-skills-memory/) — same convention exception as /feature-design: docs are versioned with the code, not with project memory.
When to use
- Onboarding users to a feature:
/docs-pack ./features/auth --type user-guide --audience user - API documentation:
/docs-pack src/api --template api-reference --audience developer - Operational runbook:
/docs-pack ./services/payment --template runbook --audience operator - Architecture overview:
/docs-pack . --template architecture --audience developer
Not for
- Internal technical docs (ADRs, design decisions) → use internal wiki /
docsskill - Code comments, docstrings → IDE / language-native tools
- Marketing copy or blog posts →
/content-creation
Invocation
/docs-pack src/api --template api-reference
/docs-pack ./features/auth --type user-guide
/docs-pack . --template architecture --audience developer
Arguments
| Flag | Default | Effect |
|---|---|---|
| <path> (positional) | required | Directory or file to document |
| --template | auto-detect | api-reference, user-guide, runbook, architecture |
| --audience | developer | developer, operator, user |
Templates
Each --template value maps to a starter document under
assets/templates/. Copy the file into
<repo>/docs/<module>/, rename, and fill in the placeholders.
| --template | File | What it covers |
|---|---|---|
| api-reference | assets/templates/api-reference.md | OpenAPI 3.1-aligned endpoint reference: per-endpoint Summary, Auth, Request/Response, Errors, Rate limits, curl + Python + JS examples, related endpoints. Top-level Overview, Auth, Versioning, Common patterns. For HTTP APIs the OpenAPI spec is the preferred co-output |
| user-guide | assets/templates/user-guide.md | Diátaxis Tutorial + How-to hybrid: a 10-minute learning tutorial (Goal, Prerequisites, Steps, Verify, Recap) followed by a set of problem-oriented How-to procedures |
| runbook | assets/templates/runbook.md | SRE-aligned operator runbook: service overview, SLO/SLI/SLA, Alert → Diagnose → Mitigate → Verify per alert, top 5 incident playbooks, rollback, escalation matrix, on-call cheatsheet |
| architecture | assets/templates/architecture.md | C4-aligned architecture doc: Mermaid C4Context + C4Container diagrams, 3–5 sequenceDiagram flows, tech stack table, quality attributes, ADR ledger, risks |
Output (versioned with code, not with project memory)
Files written to <repo>/docs/<module>/ — versioned in git as project documentation:
README.md— overview + quick-startAPI-REFERENCE.md(if applicable) — endpoint/function docsRUNBOOK.md(if operational) — procedures, troubleshootingEXAMPLES.md— code examples, use cases- (Optional) Mermaid diagrams for flows / architecture
Memory writes (workflow run logs) go to L4 .ai-skills-memory/docs/<module>/ separately.
Agent roster
| Agent | Model | Effort | Tools | Role |
|---|---|---|---|---|
| content-writer | inherit | medium | Read, Grep, Glob, Write | Writes documentation from code + examples |
| solution-architect (default reviewer) | inherit | medium | Read, Bash, Grep | Cross-stack technical review, accuracy check |
| stack-specific engineer (optional, per team-protocols/role-selection-table.md) | inherit | medium | Read, Bash, Grep | Deep accuracy review when the docs target a single stack — backend-engineer (software-engineer/python-engineer/java-engineer), frontend-engineer, db-engineer, sre-engineer, etc. Selected by the Lead from the role-selection table |
| seo-engineer (if public-facing) | inherit | low | Read, Write | GEO/SEO optimization pass per geo-content rule + geo-writer skill |
Pipeline
┌─ content-writer:
│ - Read source code, docstrings, tests
│ - Extract examples
│ - Generate documentation per template
│ → Draft docs in <repo>/docs/<module>/
│
├─ Reviewer (solution-architect by default; stack-specific engineer
│ selected per team-protocols/role-selection-table.md when scope is
│ single-stack — e.g. python-engineer for a FastAPI service,
│ frontend-engineer for a React component, sre-engineer for runbooks):
│ - Review accuracy, completeness, runnability of examples
│ - Suggest improvements
│ → feedback.md (in .ai-skills-memory/docs/<module>/)
│
├─ content-writer revisions:
│ └─ Address feedback, finalize
│
├─ (If --audience = user OR public-facing) seo-engineer:
│ └─ Apply @geo-writer (structure pass) + @humanizer (voice pass) per geo-content + humanize-content rules
│
└─ Memory write: L4 generation summary
Report: docs location + update reminder
No RALF — docs generated in one pass with optional reviewer pass.
G7 spawn payloads
content-writer, the reviewer (solution-architect or stack-specific engineer), and seo-engineer spawns use structured G7 payloads per plugin/schemas/spawn-payload.schema.json. Returns validated against plugin/schemas/return-contract.schema.json. Reviewer role selection follows plugin/skills/team-protocols/role-selection-table.md.
Eval rubric
Pointer: plugin/eval/judge-rubrics/docs-pack.md (B10).
Dimensions:
- Completeness — all key concepts documented per template
- Clarity — examples are runnable, explanations clear
- Accuracy — matches actual code behavior (verified by reviewer — solution-architect or stack-specific engineer)
- Organization — logical flow, easy to navigate
- Style consistency — follows
docsskill style guide +geo-contentrule (if public-facing)
Pass: avg ≥ 4.0, no dimension < 3.
Memory writes
| Layer | When | Shape |
|---|---|---|
| L4 | After complete | .ai-skills-memory/docs/<module>/generation-summary.md — what was documented, when, audience, files emitted |
Failure modes
- Source code poorly documented (no docstrings, no tests): content-writer infers from code + flags as
[INFERRED — needs review]in the doc - API changed since docs written (re-run scenario): reviewer catches; content-writer updates affected sections
- Examples don't run: content-writer tests examples; fixes or removes broken ones; flags as
[EXAMPLE TESTED]for those that pass - Public-facing flag set but no
marketing/MARKETING.md: seo-engineer warns about missing brand context; uses generic GEO defaults
Observability events
workflow_start— docs-pack + path + templateagent_spawned× 2–3 (content-writer, reviewer, optional seo-engineer)workflow_end—COMPLETEwith file count
Integration
- Orchestrator:
feature-design-lead - Schemas:
plugin/schemas/spawn-payload.schema.json,plugin/schemas/return-contract.schema.json - Companions:
/subagent-spawn,/context-load - Knowledge skills:
docs(general writing patterns),geo-writer(GEO structure pass),humanizer(voice pass),content-creation(when marketing/blog content overlaps with the docs pack) - Rules:
subagent-isolation,untrusted-content-wrapping(G1 wrap on source code reads),geo-content(if public-facing — mandatory per rule),humanize-content(mandatory for public-facing per rule),memory-discipline - Hooks:
tool-output-normalize.py(G2 on extracted code samples)
Related Skills
avav25/knowledge-sync
development
VerifiedTrustedCommunity
Use this skill when running the recurring (daily) knowledge-base rescan for a repo that already has knowledge/.knowledge-sync.yml — the main-thread dispatcher that reads the config, computes the git delta since last_scanned_sha, maps changed paths to affected doc areas, early-exits cheaply when nothing changed, then fans out one Agent(content-writer) per affected area, applies the propose/direct update policy, advances the baseline only on success, and writes an L4 run log — all with the G1 untrusted-content choke-point, secret-scan, deny-list, and budget controls woven in. For first-time setup use /knowledge-sync-init.
1SKILL.mdUpdated May 24, 2026
avav25/knowledge-sync-init
development
VerifiedTrustedCommunity
Use this skill when bootstrapping scheduled knowledge-base sync for a repo that has no knowledge/.knowledge-sync.yml yet — to run one-time setup that detects the knowledge_root from CLAUDE.md/AGENTS.md, maps doc areas to source globs, records opt-in external sources (Linear/Notion/WebFetch, all disabled by default), captures a baseline last_scanned_sha, sets the per-area update policy, generates or seeds knowledge/CONVENTIONS.md, provisions the L4 memory dir, and offers to register the daily routine. Routes ongoing recurring sync operations to /knowledge-sync.
1SKILL.mdUpdated May 24, 2026
avav25/ai-skills-init
tools
VerifiedTrustedCommunity
Use this skill when bootstrapping a target repository to be ai-skills-aware — on the first run of any ai-skills workflow in a fresh repo, when adopting the ai-skills plugin in an existing repo, or after upgrading to a plugin version that adds new memory paths or templates, including when the user does not say "init" but asks to "set up" or "onboard" the repo — to detect codebase type, create CLAUDE.md + AGENTS.md scaffolding, initialize the .ai-skills-memory/ directory tree from L1 templates, and configure .gitignore. Idempotent — safe to re-run. Accepts `--codebase-type <type>` and `--overwrite`. Not for re-initializing only memory — use `/memory-init` instead.
1SKILL.mdUpdated May 18, 2026
avav25/plugin-author
tools
VerifiedTrustedCommunity
Use this skill when extending, repairing, or improving plugin assets, when ingesting a `/feedback` report as a fix-cycle backlog, or when you do not remember which lower-level command is right for the job — the umbrella workflow for ai-skills plugin-asset authoring and maintenance: creating, auditing, fixing, improving, refactoring, and migrating skills, agents, rules, hooks, prompts, schemas, and rubrics inside the plugin. Auto-classifies the request, loads the right knowledge skills (`@prompt-engineering`, `@context-engineering`, `@team-protocols`), and spawns the right subagents (`prompt-engineer`, `system-architect`, `python-engineer`, `software-engineer`, `qa-engineer`, `eval-judge`) via the `Agent` tool.
1SKILL.mdUpdated May 14, 2026