Agent skill

Technical Documentation

by openclaw in openclaw/clawhub

Build and review high-quality technical docs as well as agent instruction files in your repository.

MITAuto-check passedAgent Workflows

Install Technical Documentation

skills CLI
$ npx skills add openclaw/clawhub --skill technical-documentation -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install openclaw/clawhub technical-documentation --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/openclaw/clawhub.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/technical-documentation .claude/skills/technical-documentation && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
technical-documentation
GitHub stars
9.5k
Token cost
~1.5k tokens
SKILL.md length
652 words
Files
13 (incl. references, assets)
Skills in repo
57
Repo updated
First seen
Licence
MIT

At a glance

Build and review high-quality technical docs as well as agent instruction files in your repository.

  • Works in 12 steps: Classify task: build or review; context:… → Inventory full documentation scope early… → Detect multilingual scope (README/docs… → …
  • Tasks that involve Technical documentation
  • SKILL.md covers Purpose, When to use, Workflow and Sub-agent orchestration guidance, plus 2 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Technical Documentation is an agent skill from openclaw/clawhub. Build and review high-quality technical docs as well as agent instruction files in your repository.

Its SKILL.md is about 1.5k tokens, which your agent loads only when the skill is triggered. The skill folder holds 15 other files, including reference files and assets (for example `agents/docs-framework-agent.md`, `agents/governance-agent.md` and `agents/inventory-agent.md`).

It sits in Agent Workflows, covering Technical documentation and Agent instruction files. The repository describes itself as: Skill + Plugin Registry for OpenClaw. The licence is MIT.

When your agent uses it

  • Tasks that involve Technical documentation
  • Tasks that involve Agent instruction files

Example prompts

  • “/technical-documentation”

Workflow steps

12 steps, taken from the first numbered list in SKILL.md.

  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…
  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…
  5. Read references/principles.md for the governing ruleset (Matt Palmer & OpenAI).
  6. For OpenClaw docs work, read references/openclaw.md before the build/review playbook.
  7. For build tasks, follow references/build.md.
  8. For review tasks, follow references/review.md and proactively detect issues without waiting for repeated prompts.
  9. For complex or high-risk tasks (build or review), it is acceptable to run longer, deeper, and more exhaustive investigations when needed…
  10. When available, use sub-agents for bounded parallel discovery/review work, then merge outputs into one coherent final deliverable.
  11. Use references/tooling.md when platform/tooling choices affect recommendations.
  12. Run a proactive issue sweep for both governance and docs-content surfaces, and fix high-confidence defects in the same pass unless…

What it can do on your machine

Read from SKILL.md and the folder at commit a18bc74. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Technical Documentation loads about 1.5k tokens when it runs, and up to ~9.4k if it reads all its reference files. Until then it costs about 31 tokens; SKILL.md has 652 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~31
When it runs · the whole SKILL.md, loaded when a task matches
~1.5k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~9.4k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from openclaw/clawhub at commit a18bc74, republished under its MIT licence (© openclaw). 652 words, ~1,457 tokens.

Download SKILL.mdSave it as .claude/skills/technical-documentation/SKILL.md (or your agent's skills folder). This skill also uses 12 other files; get the full folder from GitHub.
name
technical-documentation
description
Build and review high-quality technical docs as well as agent instruction files in your repository.
license
MIT
metadata.source
https://github.com/vincentkoc/dotskills

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 AGENTS.md is treated as canonical when present and aliases should be kept as compatibility surfaces.
  • Diagnosing agent-file drift where teams had to prompt iteratively to surface missing files, broken commands, or policy conflicts.
  • Applying repository-specific documentation overlays, including OpenClaw page-type, docs IA, preservation, and validation rules when present.

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 OpenClaw docs work, read references/openclaw.md before the build/review playbook.
  7. For build tasks, follow references/build.md.
  8. For review tasks, follow references/review.md and proactively detect issues without waiting for repeated prompts.
  9. For complex or high-risk tasks (build or review), it is acceptable to run longer, deeper, and more exhaustive investigations when needed for confidence.
  10. When available, use sub-agents for bounded parallel discovery/review work, then merge outputs into one coherent final deliverable.
  11. Use references/tooling.md when platform/tooling choices affect recommendations.
  12. 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.
  13. In brownfield mode, prioritize compatibility with current docs IA, tooling, and release state.
  14. In evergreen mode, prioritize timeless wording, update strategy, and durable structure.
  15. Return deliverables plus validation notes, parity status, and remaining gaps.
Show full SKILL.md (259 more words)Show less

Sub-agent orchestration guidance

Prefer sub-agents when the repo is large or the requested change set is broad; use them by default for repo-wide, multi-framework, or high-conflict work.

  • inventory-agent -> agents/inventory-agent.md (fast / Claude haiku): file/config discovery, coverage map, and missing-path checks.
  • governance-agent -> agents/governance-agent.md (thinking / Claude sonnet): AGENTS/CONTRIBUTING/alias precedence, conflicts, and policy drift.
  • docs-framework-agent -> agents/docs-framework-agent.md (thinking / Claude sonnet): framework config, relative path base, and file-path vs URL-path mapping checks.
  • synthesis-agent -> agents/synthesis-agent.md (long / Claude opus): merge sub-agent outputs into one prioritized fix plan and unified precedence model.

Inputs

  • Doc type (tutorial, how-to, reference, explanation) and audience.
  • File scope or diff scope.
  • Docs framework/tooling constraints (Fern, Mintlify, Sphinx, etc.).
  • Build/review mode and brownfield/evergreen intent.
  • Target agent and human compatibility intent.
  • Docs framework surfaces in scope (for example Fern, Sphinx, Mintlify, Markdown/MDX/MDC/RST/RSC files).
  • Desired investigation depth/time budget (quick pass vs exhaustive review).
  • Execution mode (single-agent or sub-agent-assisted when available).
  • Remediation mode (apply-fixes by default, or report-only when requested).
  • Multilingual scope: source-of-truth language, target locales, and parity expectations.
  • Repository-specific overlay constraints, if any.

Outputs

  • Updated draft or review findings with clear next actions.
  • Validation notes (what was checked, what remains).
  • Navigation/maintenance recommendations for long-term quality.
  • Governance-doc alignment summary when AGENTS/CONTRIBUTING were touched.
  • Agent instruction-surface map (primary file, alias files, Codex/Claude/Cursor handling plan).
  • Documentation-surface coverage map (what was reviewed under /docs, README hierarchy, and framework-specific source trees).
  • Autodetected issue list with applied fixes (or explicit report-only findings).
  • Delegation notes when sub-agents were used (scope delegated and how findings were merged).
  • Multilingual parity note (in-sync, partial with rationale, or intentionally divergent).
  • Repository-specific overlay notes when one was used.

© openclaw, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 12 other files (references, assets) in .agents/skills/technical-documentation of openclaw/clawhub.

  • SKILL.md
  • agents/docs-framework-agent.md
  • agents/governance-agent.md
  • agents/inventory-agent.md
  • agents/openai.yaml
  • agents/synthesis-agent.md
  • assets/icon.jpg
  • references/agent-and-contributing.md
  • references/build.md
  • references/openclaw.md
  • references/principles.md
  • references/review.md
  • references/tooling.md

Open the folder on GitHubat commit a18bc74

Compare with similar skills

Technical Documentation next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Technical Documentation compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Technical Documentation this skillopenclaw/clawhub9.5k—~1.5kAutomated safety check: PassMIT
Neat-Freak Knowledge CloseoutKKKKhazix/khazix-skills21k—~1.9kAutomated safety check: PassMIT
Dsh Web Documentationzhu1090093659/dsh-web8.4k—~479Automated safety check: PassApache-2.0
Newprojectscunning1975/MixtapeTools4691 repos~850Automated safety check: PassNone
Sync Public DocsCaldis/react-zmage946—~3.3kAutomated safety check: PassMIT
Review DocsKaggle/kaggle-environments454—~2.7kAutomated safety check: PassApache-2.0

Similar skills

  • Neat-Freak Knowledge Closeout

    KKKKhazix/khazix-skills

    Brings project docs, agent rule files, authorized memory and leftover workspace files back in line with what the code and runtime actually do at the end of a work session.

    21k GitHub stars~1.9k tokensUpdated 6 days ago
    Agent WorkflowsAuto-check passed
  • Dsh Web Documentation

    zhu1090093659/dsh-web

    A skill your agent uses when adding or editing dsh-web README files, docs, AGENTS.md instructions, user-facing configuration text, or bilingual documentation pairs.

    8.4k GitHub stars~479 tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Newproject

    scunning1975/MixtapeTools

    Scaffold a new research project with standard directory structure, CLAUDE.md template, and documented README.

    469 GitHub starsUsed in 1 repo~850 tokens
    Agent WorkflowsAuto-check passed
  • Sync Public Docs

    Caldis/react-zmage

    A skill your agent uses when modifying public API in packages/core (types/global.ts, types/default.ts, index.ts, or package.json exports field), adding/renaming/removing props, changing default…

    946 GitHub stars~3.3k tokensUpdated 4 mo ago
    Agent WorkflowsAuto-check passed
  • Review Docs

    Kaggle/kaggle-environments

    Audit a game environment's README.md and AGENTS.md against its engine implementation.

    454 GitHub stars~2.7k tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Documentation

    samchon/typia

    Defines README, website-guide, and agent-instruction structure, audience, prose formatting, and voice for typia.

    5.9k GitHub stars~1.1k tokensUpdated today
    Agent WorkflowsAuto-check passed

More from openclaw/clawhub

All 57 skills in this repo
  • Creates and manages Axiom monitors and notifiers end to end through the v2 API, with scripts for each CRUD operation and a recommended create-validate-tune workflow.

    9.5k GitHub stars~2.1k tokensUpdated today
    Auto-check passed
  • Axiom Dashboard Builder

    openclaw/clawhub

    Designs and deploys Axiom dashboards through the API, choosing chart types and writing APL or metrics queries, with templates and migration notes for Splunk and Grafana.

    9.5k GitHub stars~4.9k tokensUpdated today
    Auto-check passed
  • Axiom Cost Control

    openclaw/clawhub

    Finds unused data in Axiom by analyzing query patterns, then deploys a cost dashboard and ingest monitors to keep spend under the contract limit.

    9.5k GitHub stars~1.7k tokensUpdated today
    Auto-check passed
  • Axiom Metrics Query

    openclaw/clawhub

    Explores and queries OpenTelemetry metrics in Axiom MetricsDB, listing datasets, metrics and tags first and picking the right aggregation for each metric's type.

    9.5k GitHub stars~2.6k tokensUpdated today
    Auto-check passed
  • Axiom SRE Investigator

    openclaw/clawhub

    Investigates incidents and production problems with hypothesis-driven debugging, queries Axiom observability data when available, and keeps secrets out of commands and output.

    9.5k GitHub stars~7.1k tokensUpdated today
    Auto-check passed
  • Axiom Eval Writer

    openclaw/clawhub

    Scaffolds evaluation suites for the Axiom AI SDK: eval files, scorers, flag schemas and axiom.config.ts, generated from plain descriptions of an AI capability.

    9.5k GitHub stars~4.1k tokensUpdated today
    Auto-check: warnings

Questions about Technical Documentation

What does Technical Documentation do?

Build and review high-quality technical docs as well as agent instruction files in your repository. Technical Documentation is an agent skill from openclaw/clawhub. Build and review high-quality technical docs as well as agent instruction files in your repository.

When should I use Technical Documentation?

Technical Documentation fits situations like: tasks that involve Technical documentation; tasks that involve Agent instruction files.

How do I install Technical Documentation in Claude Code?

Run `npx skills add openclaw/clawhub --skill technical-documentation -a claude-code`. Or copy the skill folder (.agents/skills/technical-documentation in openclaw/clawhub) into .claude/skills/technical-documentation in your project. Claude Code loads it when a task matches its description.

How do I install Technical Documentation in Codex?

Run `npx skills add openclaw/clawhub --skill technical-documentation -a codex`. Or copy the skill folder (.agents/skills/technical-documentation in openclaw/clawhub) into .agents/skills/technical-documentation in your project. Codex loads it when a task matches its description.

Can I use Technical Documentation in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add openclaw/clawhub --skill technical-documentation -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/technical-documentation, .gemini/skills/technical-documentation, .github/skills/technical-documentation and .opencode/skills/technical-documentation in your project.

What does Technical Documentation need to run?

SKILL.md names no scripts, command-line tools or credentials: Technical Documentation is instructions for the agent only.

Does Technical Documentation access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Technical Documentation safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Technical Documentation use?

Technical Documentation is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Technical Documentation use?

About 1.5k tokens (SKILL.md is roughly 5.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 7.9k tokens, read only when the agent opens those files.

What are the alternatives to Technical Documentation?

Skills that share tags, products or a category with Technical Documentation: Neat-Freak Knowledge Closeout (KKKKhazix/khazix-skills, 21k stars), Dsh Web Documentation (zhu1090093659/dsh-web, 8.4k stars), Newproject (scunning1975/MixtapeTools, 469 stars) and Sync Public Docs (Caldis/react-zmage, 946 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Technical Documentation?

openclaw (a GitHub organization) maintains it in openclaw/clawhub, which has 9,489 GitHub stars. The repository holds 57 skills in this directory. The repository was last updated on October 6, 2026.

Source: openclaw/clawhub on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.