CtrlK
BlogDocsLog inGet started
Tessl Logo

update-docs

Update and maintain project documentation for local code changes using multi-agent workflow with tech-writer agents. Covers docs/, READMEs, JSDoc, and API documentation.

39

Quality

38%

Does it follow best practices?

Impact

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

Fix and improve this skill with Tessl

tessl review fix ./plugins/docs/skills/update-docs/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

27%

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

This skill suffers primarily from extreme verbosity and poor progressive disclosure. It contains substantial generic documentation philosophy and best practices that Claude already knows, diluting the actionable workflow content. The core multi-agent workflow (steps 1-11) is reasonable but is buried in hundreds of lines of advisory content that should either be removed or split into referenced files.

Suggestions

Reduce content by 60-70%: Remove the 'Core Documentation Philosophy', 'Smart Documentation Strategy', 'Documentation Audit Guidelines', and generic pattern sections—Claude already knows these concepts. Keep only project-specific conventions.

Extract agent instruction templates, index document tables, and documentation patterns into separate bundle files (e.g., agents/templates.md, patterns/index-docs.md) and reference them from the main skill.

Add concrete validation commands in the workflow—instead of delegating quality review entirely to agents with vague criteria, include specific checks like link validation commands, example execution verification, or diff review steps.

Tighten the workflow to focus on the decision tree (simple vs. multi-agent) and the specific steps, removing philosophical framing that doesn't change Claude's behavior.

DimensionReasoningScore

Conciseness

This skill is extremely verbose at ~400+ lines. It explains concepts Claude already knows (what documentation is, what JSDoc is, what OpenAPI does), includes extensive philosophy sections ('Documentation Hierarchy', 'What NOT to Document'), lengthy audit guidelines, and tool comparisons that don't add actionable value. The 'Documentation Patterns Reference' section alone contains generic best practices that Claude inherently understands. Much of this content competes with conversation context without earning its place.

1 / 3

Actionability

The skill provides some concrete guidance like bash commands for finding documentation files and agent instruction templates with clear structure. However, much of the content is philosophical rather than executable—sections like 'Core Documentation Philosophy', 'Documentation Audit Guidelines', and 'Smart Documentation Strategy' describe approaches rather than instruct. The agent templates use placeholder variables but are reasonably structured. The workflow steps mix actionable commands with vague directives like 'Analyze documentation structure'.

2 / 3

Workflow Clarity

The workflow has a clear numbered sequence (steps 1-11) with a decision point for simple vs. multi-agent flow, and includes a quality review loop (step 10). However, validation checkpoints are weak—the quality review is delegated to agents with vague 'PASS/ISSUES' output rather than concrete validation commands. The workflow also lacks explicit error recovery for common failure modes (e.g., what if agents produce conflicting documentation, what if git has no changes). The iteration step is present but loosely defined.

2 / 3

Progressive Disclosure

Despite referencing external files like '@/plugins/sdd/agents/tech-writer.md', the skill itself is monolithic with massive inline content that should be split into separate files. The Documentation Patterns Reference, Documentation Audit Guidelines, Smart Documentation Strategy, and agent templates could all be separate referenced files. No bundle files are provided, so the referenced tech-writer agent file cannot be verified. The skill tries to be both an overview and a comprehensive reference, failing at progressive disclosure.

1 / 3

Total

6

/

12

Passed

Description

50%

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 provides a reasonable overview of the skill's purpose and covers specific documentation types, but lacks an explicit 'Use when...' clause and could benefit from more concrete action verbs and natural trigger terms. The mention of multi-agent workflow is distinctive but may not help users identify when to use this skill.

Suggestions

Add an explicit 'Use when...' clause, e.g., 'Use when code changes require documentation updates, when the user asks to update docs, READMEs, or API references after modifying code.'

Include more natural trigger terms users would say, such as 'update docs', 'write documentation', 'docstrings', 'markdown files', '.md files', or 'document my code'.

List more specific concrete actions beyond 'update and maintain', e.g., 'generates JSDoc comments, updates README files, syncs API documentation with code changes, maintains docs/ directory content'.

DimensionReasoningScore

Specificity

Names the domain (project documentation) and some actions ('update and maintain'), and lists specific targets (docs/, READMEs, JSDoc, API documentation), but doesn't list multiple concrete discrete actions beyond 'update and maintain'.

2 / 3

Completeness

Answers 'what' (update and maintain project documentation using multi-agent workflow) and implicitly suggests 'when' (for local code changes), but lacks an explicit 'Use when...' clause with clear trigger guidance.

2 / 3

Trigger Term Quality

Includes some relevant keywords like 'documentation', 'READMEs', 'JSDoc', 'API documentation', and 'docs/' that users might mention, but misses common variations like 'docstrings', 'code comments', 'update docs', 'write documentation', or file extensions like '.md'.

2 / 3

Distinctiveness Conflict Risk

The mention of 'multi-agent workflow with tech-writer agents' and specific targets like JSDoc and docs/ adds some distinctiveness, but 'project documentation' is broad enough to potentially overlap with general documentation or code commenting skills.

2 / 3

Total

8

/

12

Passed

Validation

81%

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

Validation9 / 11 Passed

Validation for skill structure

CriteriaDescriptionResult

skill_md_line_count

SKILL.md is long (661 lines); consider splitting into references/ and linking

Warning

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

9

/

11

Passed

Repository
NeoLabHQ/context-engineering-kit
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.