technical-documentation

A set of rules for writing and reviewing technical documentation and instruction files in a software repository. It covers product docs, contributor guides, and files that tell coding agents how to work.

In plain words
What is it for?
Use it to create or overhaul documentation, review doc changes, audit repository docs, and align contributor or agent instructions.
Why use it?
It helps keep documentation clear, usable, consistent with the codebase, and maintainable as the project changes.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/vincentkoc/dotskills/technical-documentation
Any agent
npx skills add vincentkoc/dotskills --skill technical-documentation
Clone the repo
git clone --depth 1 https://github.com/vincentkoc/dotskills

Made for: Claude Code, Codex.

Per session 21 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,178 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00021 $0.01178
Opus 5 $0.00010 $0.00589
Sonnet 5 $0.00004 $0.00236
Haiku 4.5 $0.00002 $0.00118

Measured 3d ago against content hash e9325cdfb92c, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

technical-documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/technical-documentation/SKILL.md · 76 lines

How it starts

The opening of the file, as written. The whole thing — 76 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Technical Documentation

Purpose

Produce and review technical documentation that is clear, actionable, and maintainable for both humans and agents, including contributor-governance files and agent instruction files.

When to use

  • Creating or overhauling docs in an existing product/codebase (brownfield).
  • Building evergreen docs meant to stay accurate and reusable over time.
  • Reviewing doc diffs for structure, clarity, and operational correctness.
  • Running full-repo documentation audits that must include both governance files and product docs surfaces (docs/, README*, .md/.mdx/.mdc, Fern/Sphinx/Mintlify-style sources).
  • Updating or reviewing AGENTS.md and/or CONTRIBUTING.md to keep agent and contributor workflows aligned with current repo practices.
  • Improving repository onboarding/docs that include contribution instructions, issue templates, PR flow, and review gates.
  • Designing governance documentation strategy for repos with alias instruction files (for example CLAUDE.md, AGENT.md, .cursorrules, .cursor/rules/*, .agent/, .agents/, .pi/) where CLAUDE.md is treated as a canonical policy source and AGENTS.md should be kept as compatibility alias if present.
  • Diagnosing agent-file drift where teams had to prompt iteratively to surface missing files, broken commands, or policy conflicts.

Workflow

  1. Classify task: build or review; context: brownfield or evergreen.
  2. Inventory full documentation scope early (governance + product docs): AGENTS/CONTRIBUTING/aliases plus docs directories, framework sources, and root/module READMEs.
  3. Detect multilingual scope (README/docs in multiple languages) and define required parity level.
  4. Read references/agent-and-contributing.md for agent instruction and CONTRIBUTING.md workflow rules (inventory, canonical/alias mapping, dual-mode balance, deliverable standards, and precedence/conflict handling).
  5. Read references/principles.md for the governing ruleset (Matt Palmer & OpenAI).
  6. For build tasks, follow references/build.md.
  7. For review tasks, follow references/review.md and proactively detect issues without waiting for repeated prompts.
  8. For complex or high-risk tasks (build or review), it is acceptable to run longer, deeper, and more exhaustive investigations when needed for confidence.
  9. When available, use sub-agents for bounded parallel discovery/review work, then merge outputs into one coherent final deliverable.
  10. Use references/tooling.md when platform/tooling choices affect recommendations.
  11. Run a proactive issue sweep for both governance and docs-content surfaces, and fix high-confidence defects in the same pass unless explicitly asked for report-only mode.
  12. In brownfield mode, prioritize compatibility with current docs IA, tooling, and release state.
  13. In evergreen mode, prioritize timeless wording, update strategy, and durable structure.
  14. Return deliverables plus validation notes, parity status, and remaining gaps.

Read the full file on GitHub · 76 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 76 lines · 21 tokens per session scan A e9325cdfb92c

Subscribe to this mod's changes

technical-documentation is a skill published in the GitHub repository vincentkoc/dotskills (102 stars, last pushed 11d ago), licensed MIT. It adds 21 tokens to every session and 1,178 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

panel-app-creator

Create or update the Panel App UI part of a NextClaw lightweight app. Use after nextclaw-app-creator selects Panel-only or Panel + Service, or when the user explicitly asks for a right-side Panel App UI, folder-based static panel, Service Actions UI, Agent-powered Panel App, React/Vite/Tailwind Panel App, or asks what…

Peiiii/nextclaw · 93 tokens

service-app-creator

Create or update the Service App backend action part of a NextClaw lightweight app. Use after nextclaw-app-creator selects Service-only or Panel + Service, or when the user explicitly asks for workspace service-apps, MCP-compatible backend helpers, file access, external API calls, local commands, or privileged actions.

Peiiii/nextclaw · 69 tokens

nextclaw-dead-code-governance

当用户要求扫描、识别、清理、常态化治理 NextClaw 仓库里的死代码、无用代码、unused files、unused exports、unused dependencies,尤其是核心包越来越臃肿、想删旧实现或做定期减债时使用。.

Peiiii/nextclaw · 71 tokens

nextclaw-http-agent-runtime-integration

Use when integrating or debugging a Hermes-style external HTTP agent runtime in NextClaw, including runtime config, session selection, readiness, streaming, and adapter behavior.

Peiiii/nextclaw · 41 tokens

nextclaw-product-visual-assets

当 NextClaw 产品更新后需要生成、替换、挑毛病或检查官网、GitHub README、用户文档或社交传播中的真实截图、AI 宣传视觉、整页 HTML 宣传预览、社区二维码等对外视觉资产时使用;也用于“更新截图”“重新截一批图”“做宣传页”“生成 campaign 页面”“视觉审稿”“五星挑刺法”或发布前检查视觉资产。普通站点布局开发或只写文章不触发。.

Peiiii/nextclaw · 115 tokens

agent-browser

Use Agent Browser for real browser navigation, dynamic pages, and web interaction; also use it as a distinct browser-based path when websearch is unavailable or fails.

Peiiii/nextclaw · 35 tokens