CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

technical-documentation

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

Quality

69%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./.agents/skills/technical-documentation/SKILL.md

The canonical home for this skill is technical-documentation in openclaw/openclaw

SKILL.md
Quality
Evals
Security

Quality

Content

75%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The body is a well-structured orchestration overview that routes to real reference files with explicit modes and sub-agent roles, sitting noticeably above the midpoint on every dimension. Its main defects are dangling agents/*.md references, overlap between 'When to use' and 'Inputs', and an implicit rather than explicit validation feedback loop.

Suggestions

Fix the four dangling sub-agent references: either add the agents/*.md files to the bundle or remove/collapse the sub-agent section into the workflow steps.

Deduplicate 'When to use' and 'Inputs' (e.g., docs framework surfaces and governance scenarios appear in both) to tighten token efficiency.

Make the validation loop explicit for batch repo-wide fixes, e.g. after fixing defects, re-run the issue sweep and report what was fixed vs. what remains before delivering.

DimensionReasoningScore

Conciseness

The body is dense, list-based, and free of concept explanations Claude already knows; every section carries operational information. It is not a 5 because 'When to use' (10 bullets) overlaps 'Inputs', the sub-agent section restates workflow steps 9-10, and the governance-strategy bullet is a ~60-word run-on.

4 / 5

Actionability

Concrete routing guidance throughout: named reference files per workflow step, explicit modes (build/review, brownfield/evergreen, apply-fixes/report-only), and named sub-agent roles with model assignments. It is not a 5 because the four agents/*.md paths dangle with no fallback guidance, and step 9 ('acceptable to run longer, deeper') is non-directive filler.

4 / 5

Workflow Clarity

The 15-step workflow is clearly sequenced with classification up front, and validation is present via the 'high-confidence defects' gate, report-only mode, and step 15's validation notes / parity status / remaining gaps. It is not a 5 because the validate -> fix -> re-validate feedback loop for batch repo-wide fixes is implicit in outputs rather than an explicit checkpoint, and not a 3 because the sequence and gating are clearly defined.

4 / 5

Progressive Disclosure

SKILL.md is a proper overview: all six references/*.md files exist, are clearly signaled one level deep, and are each attached to a specific workflow step. It is not a 5 because four of the ten referenced paths (agents/inventory-agent.md, agents/governance-agent.md, agents/docs-framework-agent.md, agents/synthesis-agent.md) do not exist in the bundle, leaving dangling navigation; it is not a 3 because references are well-signaled and nothing that belongs in a separate file is inlined.

4 / 5

Total

16

/

20

Passed

Description

50%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

The description clearly states what the skill does and uses correct third-person voice, but it is one short generic sentence with no 'Use when...' trigger guidance and few natural trigger terms. It reads as a domain label rather than an activation spec, putting it at the midpoint of the scale.

Suggestions

Append an explicit trigger clause, e.g. 'Use when creating or reviewing README, AGENTS.md, CONTRIBUTING.md, or docs/ pages, or when running a repo documentation audit.'

Name concrete trigger terms users would actually say — 'documentation', 'docs audit', 'README', 'AGENTS.md', 'CONTRIBUTING.md', '.cursorrules' — to improve trigger-term quality and distinctiveness.

Specify the sub-capabilities (docs audits, governance-file alignment, multilingual parity checks) instead of the generic 'build and review' verb pair.

DimensionReasoningScore

Specificity

The description names its domain ('technical docs', 'agent instruction files') and two generic actions ('Build and review') but lists no concrete sub-tasks such as docs audits, README overhauls, or governance-file alignment, matching the 'domain and 1-2 concrete actions, not comprehensive' anchor. It is not a 4 because 'build' and 'review' alone are too generic to count as several specific actions.

3 / 5

Completeness

The 'what' is clear (build and review technical docs and agent instruction files), but there is no 'Use when...' clause or equivalent trigger guidance, which caps completeness at 3 per the judging guidelines. It is not a 2 because the 'what' is clearly stated, and not a 4 because 'when' is entirely absent rather than merely weakly explicit.

3 / 5

Trigger Term Quality

Keywords are limited to 'technical docs', 'agent instruction files', and 'repository'; natural phrases users would say such as 'documentation', 'README', 'AGENTS.md', or 'CONTRIBUTING' are absent. This matches the anchor for some relevant keywords but missing common variations or synonyms, and falls short of good keyword coverage.

3 / 5

Distinctiveness Conflict Risk

The 'agent instruction files' angle is a distinguishing niche, but 'build and review high-quality technical docs' broadly overlaps general writing and docs skills, so it could still trigger for the wrong skill. It is not a 4 because the docs half of the description is generic enough to conflict with closely related skills.

3 / 5

Total

12

/

20

Passed

Validation

93%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

metadata_version

'metadata.version' is missing

Warning

Total

15

/

16

Passed

Repository

openclaw/clawhub

Path

.agents/skills/technical-documentation/SKILL.md

Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.