CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

documenter

Documenta arquitetura, decisoes, uso e operacao do projeto. 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".

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.

The body delivers genuinely actionable guidance — concrete CLI commands, mandatory-content checklists, decision tables, and verification gates — but it carries too much weight in SKILL.md itself. The repo-wiki mode (~140 lines) should live in the guide file the skill already names, and repeated template pointers plus unverifiable external references weaken both conciseness and progressive disclosure.

Suggestions

Move the Modo Repo-Wiki section (evidence contract, analysis.json semantics, CLI behavior, saída canônica, limites) into docs/skill-guides/documenter-repository-intelligence.md, keeping in SKILL.md only the trigger conditions, the four execution modes, and the four CLI commands.

Consolidate the three repeated pointers to docs/skill-guides/documenter-templates.md into a single Templates section so the deferral is stated once.

Trim the Fontes section to one line per upstream source; the detailed curation rationale (grep evidence, what was and was not ported) adds tokens without changing agent behavior.

DimensionReasoningScore

Conciseness

The body is mostly efficient and free of concept-explanation padding, but it could be tightened: the pointer to docs/skill-guides/documenter-templates.md is repeated three times ("consultar ... apenas quando necessario", "Para templates completos de runbook e playbook, consultar...", "quando precisar dos templates completos"), and roughly 80 lines of repo-wiki prose (analysis.json schema semantics, compiler/builder behavior) duplicate material the body itself assigns to a separate guide. This fits anchor 3 (mostly efficient, some unnecessary explanation); it is above anchor 2 because nearly all content is actionable rather than padded, and below anchor 4 because the redundancy is more than minor.

3 / 5

Actionability

Concrete, executable guidance is present throughout: a copy-paste CLI block ("node scripts/run-repo-wiki-runtime.mjs --repo . --output docs/repo-wiki/runtime.json --allow-execution" and three more commands), a full directory tree, per-level mandatory-content checklists, and a specific grep checkpoint. It is not 5 because the central feature/ADR authoring workflow depends entirely on external templates and scripts (templates/doc-update.md, scripts/*.mjs, policies/*.md) that are not part of the skill bundle, leaving gaps a reader cannot resolve from the skill alone.

4 / 5

Workflow Clarity

The repo-wiki flow is clearly sequenced with validation: read permitted sources, write analysis, run generator/build, verify with "node scripts/verify-repo-wiki.mjs --docs ... --site ... --json", and a completion gate ("Markdown válido e ... links locais resolvidos, busca offline presente e external_requests: 0"). The feature-doc path also has a feedback loop ("se ainda houver repetição, repetir a busca antes de considerar a doc pronta"). It is not 5 because the primary 4-level documentation workflow is distributed across Quando Usar / Quando Documentar / Regras sections rather than given as one ordered sequence with checkpoints.

4 / 5

Progressive Disclosure

The skill references external files (11 policies, two docs/skill-guides guides, templates, four scripts) but none exist in a references/, scripts/, or assets/ bundle, so the deferral cannot be verified from the skill itself. Meanwhile ~140 lines of repo-wiki operational detail (evidence contract, output structure, CLI behavior, limits) are inlined even though the body names a dedicated guide for that mode — the anchor-3 pattern of content that should be separate being inline. It is above anchor 2 because sections are well-organized with clear headers and deferral is signaled, and below anchor 4 because the inlined repo-wiki block is exactly the content that belongs in the referenced guide.

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: a clear one-line capability statement followed by an extensive, natural, bilingual trigger list that explicitly covers both what and when. The only weakness is a handful of off-niche trigger terms that create minor routing overlap with security and automation skills.

DimensionReasoningScore

Specificity

"Documenta arquitetura, decisoes, uso e operacao do projeto" names four concrete documentation targets, matching the anchor for several specific actions with minor gaps. It is not 5 because a single verb covers all capabilities — richer concrete actions (offline HTML site, repo improvement matrix) appear only in the body, and it is above anchor 3 since more than 1-2 concrete items are named.

4 / 5

Completeness

It explicitly answers both questions: the what ("Documenta arquitetura, decisoes, uso e operacao do projeto") and the when via a dedicated "Trigger em:" clause with concrete trigger phrases. This matches the top anchor exactly; it is not 4 because the when-guidance is fully explicit, not merely present.

5 / 5

Trigger Term Quality

The trigger list is comprehensive and natural in both Portuguese and English: "documentar", "docs", "ADR", "runbook", "README", "registrar decisão", "atualizar docs", "repo wiki", plus domain vocabulary like "C4" and "troubleshooting". This matches the anchor for comprehensive coverage including synonyms; no common variation is obviously missing.

5 / 5

Distinctiveness Conflict Risk

The documentation niche is clear with distinct triggers ("ADR", "runbook", "README", "repo wiki"), fitting anchor 4 (mostly distinct, minor overlap risk). It is not 5 because off-niche tail triggers like "RPA", "automação", "segurança do app" and "melhorias do repositório" would more naturally route to security, automation, or refactoring skills.

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.