CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

documenter

Skill de Documentação por nível de decisão. Use quando precisar documentar features, APIs, arquitetura, setup, operação, ou manter documentação existente atualizada. Trigger em: "documentar", "documentação", "docs", "ADR", "architecture decision record", "README", "feature doc", "api doc", "setup doc", "runbook", "troubleshooting", "doc de operação", "registrar decisão", "atualizar docs", "documentar repositório", "repo wiki", "mapa de arquitetura", "C4", "documentação completa do código", "regras de negócio", "RPA", "automação", "segurança do app", "melhorias do repositório", "site da documentação", "HTML offline", "buscar na documentação".

64

Quality

81%

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

SKILL.md
Quality
Evals
Security

Quality

Content

63%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.

A well-structured, genuinely actionable instruction skill whose checklists, directory conventions, and Repo-Wiki command pipeline give Claude concrete direction. Its main weaknesses are length: the Repo-Wiki operational detail is inlined instead of living in the already-referenced guide, and the sources/provenance narrative spends tokens on kit history rather than execution.

Suggestions

Move the Repo-Wiki execution detail (CLI flags, analysis.json schema contract, output tree, handoff specifics) into the already-referenced `docs/skill-guides/documenter-repository-intelligence.md`, keeping only the trigger conditions and the four-command summary in SKILL.md.

Reduce the "Fontes" section to one-line attributions per upstream repo; the kit-internal gap-analysis narrative (grep measurements, slash-command overlap with skills 11/53/31/45) does not aid execution.

Make the duplication checkpoint executable by giving the concrete command, e.g. `grep -rn "<regra>" docs/` before substituting duplicates with a reference to the canonical file.

DimensionReasoningScore

Conciseness

Most sections are lean prescriptive checklists (the four levels' mandatory content, directory tree, decision rules), but there is noticeable non-executable padding: the "Fontes" section narrates kit-internal provenance and gap analysis ("gap medido por grep em 'diagram' no kit antes de curar... os quatro slash commands do projeto original não foram adotados por sobreporem as skills 11, 53, 31/45"), `documenter-templates.md` is pointed to three separate times, and the geometry-verification section explains at length why visual review fails. This fits anchor 3's "mostly efficient but includes some unnecessary explanation or could be tightened" better than anchor 4, where only minor trimming would be needed.

3 / 5

Actionability

The body provides concrete, executable guidance throughout: a full directory structure, per-level mandatory-content checklists, a decision rule with a threshold ("se o conteúdo cabe numa tabela de até ~6 colunas sem quebrar, preferir tabela sobre diagrama"), copy-paste bash commands for the Repo-Wiki pipeline, an exact output tree, and explicit handoff requirements (absolute paths, file counts, pending tracks). Minor gaps keep it below anchor 5: the duplication checkpoint says "buscar (grep) o mesmo fato" without a concrete command, and no sample ADR or feature-doc excerpt is shown inline (all delegated to the templates file).

4 / 5

Workflow Clarity

The Repo-Wiki mode has a numbered 1-7 sequence that ends in validation ("validar links, fences, Mermaid/SVG, busca offline... antes do handoff") plus a completion gate ("HTML construído, links locais resolvidos, busca offline presente e external_requests: 0"), and the duplication checkpoint has an explicit retry loop (grep → substitute → re-read → repeat if needed). The core documentation workflow, however, is presented as a taxonomy of levels and rules rather than an ordered sequence with checkpoints, which is a minor gap versus anchor 5's fully sequenced, checkpointed flow — but clearly above anchor 3's implicit checkpoints.

4 / 5

Progressive Disclosure

References are clearly signaled and one level deep ("consultar `docs/skill-guides/documenter-templates.md` apenas quando necessario", `documenter-repository-intelligence.md`, `templates/doc-update.md`), and headers organize the body well — but no bundle files exist, and roughly a third of the body (the Repo-Wiki CLI flags, analysis.json schema contract, evidence rules, output layout, and execution/handoff detail) is inlined despite a dedicated guide file already being referenced for that mode. That is content which clearly belongs in a separate file inlined in SKILL.md, matching anchor 3 rather than anchor 4's "most content is appropriately placed".

3 / 5

Total

14

/

20

Passed

Description

91%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.

A strong description with explicit what/when structure and an exceptionally thorough natural-language trigger list in Portuguese. The main weaknesses are coverage gaps in the what-clause (Repo-Wiki site generation is a large part of the skill but only appears via triggers) and a few overly broad trigger terms that create overlap risk with adjacent skills.

DimensionReasoningScore

Specificity

The description lists several concrete actions across distinct artifacts — "documentar features, APIs, arquitetura, setup, operação, ou manter documentação existente atualizada" — which exceeds anchor 3's "1-2 concrete actions", but the skill's major Repo-Wiki capability (static site generation, repository intelligence, improvement matrix) surfaces only indirectly through trigger terms like "repo wiki" and "site da documentação", so coverage gaps are slightly more than minor. It sits noticeably above the midpoint between anchors 3 and 4, not at anchor 5's comprehensive coverage.

4 / 5

Completeness

It explicitly answers both questions: what ("Skill de Documentação por nível de decisão... documentar features, APIs, arquitetura, setup, operação, ou manter documentação existente atualizada") and when ("Use quando precisar documentar..." plus a concrete trigger-phrase list). This mirrors anchor 5's example structure of a clear what-clause followed by explicit when-guidance with concrete triggers; the imperative "Use quando" matches the pattern of the anchor examples rather than a first/second-person voice penalty.

5 / 5

Trigger Term Quality

The explicit "Trigger em:" list provides comprehensive natural-term coverage with ~25 phrases including synonyms ("documentar", "documentação", "docs", "atualizar docs"), artifact-specific terms ("ADR", "runbook", "C4", "repo wiki", "README"), and capability phrases ("site da documentação", "HTML offline", "buscar na documentação") — matching anchor 5's requirement for synonyms and variations users would actually say.

5 / 5

Distinctiveness Conflict Risk

The documentation niche is distinct with dedicated triggers ("ADR", "runbook", "repo wiki", "C4"), but several trigger terms are broad enough to overlap with other skills — "automação", "RPA", "segurança do app", "melhorias do repositório" would plausibly fire for automation, security-review, or repo-improvement skills. This is minor overlap with closely related domains, matching anchor 4 rather than anchor 5's minimal conflict risk.

4 / 5

Total

18

/

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

referenced_paths_exist

Referenced path issues: 5 missing

Warning

Total

15

/

16

Passed

Repository

felvieira/claude-skills-fv

Path

skills/10-documenter/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.