CtrlK
BlogDocsLog inGet started
Tessl Logo

common-documentation

Write effective code comments, READMEs, and technical documentation following intent-first principles. Use when adding comments, writing docstrings, creating READMEs, or updating any documentation.

83

1.14x
Quality

77%

Does it follow best practices?

Impact

96%

1.14x

Average score across 3 eval scenarios

SecuritybySnyk

Passed

No known issues

Fix and improve this skill with Tessl

tessl review fix ./.github/skills/common/common-documentation/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

72%

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

A concise, well-structured documentation standards skill that efficiently communicates conventions and anti-patterns. Its main weakness is the lack of concrete, copy-paste-ready examples—particularly for docstrings, README templates, and ADR formats—which would significantly improve actionability. The organization is strong and token-efficient.

Suggestions

Add a concrete docstring example showing the expected Args/Returns/Usage format (e.g., a Python or Dart docstring with `>>>` usage example).

Include a minimal README template or ADR template that Claude can directly copy and fill in, rather than just listing section names.

DimensionReasoningScore

Conciseness

Very lean and efficient. Every bullet point adds value without explaining concepts Claude already knows. No padding or unnecessary context—just actionable rules and conventions.

3 / 3

Actionability

Provides concrete guidance (e.g., TODO format, ADR location, Swagger for REST) but lacks executable code examples. Docstring format mentions Args/Returns/Usage but doesn't show a concrete example. The README structure is prescriptive but abstract.

2 / 3

Workflow Clarity

This is primarily an instruction/convention skill rather than a multi-step workflow, but the sections are clearly sequenced by concern. However, there's no guidance on when to apply which section or how to validate documentation quality—no feedback loop for checking completeness or correctness.

2 / 3

Progressive Disclosure

For a skill under 50 lines with no need for external references, the content is well-organized into clearly labeled sections (Comments, README, ADRs, API Docs, Anti-Patterns) that are easy to scan and navigate.

3 / 3

Total

10

/

12

Passed

Description

82%

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

This is a solid description that clearly communicates both purpose and trigger conditions. Its main strengths are the explicit 'Use when' clause with natural trigger terms and the mention of 'intent-first principles' as a differentiating methodology. The description could be improved with more specific concrete actions and sharper distinctiveness from adjacent coding skills.

Suggestions

Add more specific concrete actions to increase specificity, e.g., 'Write inline code comments, generate function docstrings, create project READMEs, draft API reference docs, and maintain changelogs'

Strengthen distinctiveness by clarifying what 'intent-first principles' means briefly, or by listing what this skill does NOT cover (e.g., 'Not for generating code itself or writing user-facing product copy')

DimensionReasoningScore

Specificity

Names the domain (documentation) and some actions ('write code comments, READMEs, technical documentation'), but the actions are somewhat general categories rather than multiple specific concrete operations like 'generate API reference docs, write inline code comments, create changelog entries'.

2 / 3

Completeness

Clearly answers both 'what' (write code comments, READMEs, technical documentation following intent-first principles) and 'when' (explicit 'Use when' clause covering adding comments, writing docstrings, creating READMEs, updating documentation).

3 / 3

Trigger Term Quality

Includes strong natural keywords users would say: 'comments', 'docstrings', 'READMEs', 'documentation'. These are terms developers naturally use when requesting help with documentation tasks.

3 / 3

Distinctiveness Conflict Risk

While it targets documentation specifically, 'technical documentation' is broad enough to potentially overlap with API documentation skills, code generation skills that include docstrings, or README template skills. The 'intent-first principles' qualifier adds some distinctiveness but could still conflict with general coding skills.

2 / 3

Total

10

/

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

metadata_version

'metadata.version' is missing

Warning

metadata_field

'metadata' should map string keys to string values

Warning

Total

9

/

11

Passed

Repository
HoangNguyen0403/agent-skills-standard
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.