CtrlK
BlogDocsLog inGet started
Tessl Logo

arn-code-document-project

This skill should be used when the user says "document project", "generate docs", "create documentation", "write docs", "arness code document", "arn-code-document-project", "document this feature", "document this fix", or wants to generate developer documentation for a completed feature or bug fix. Reads plan artifacts, spec files, execution reports, and git diff to produce accurate documentation. Do NOT use this for general-purpose documentation — this is specifically for Arness pipeline projects.

68

Quality

83%

Does it follow best practices?

Impact

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

SKILL.md
Quality
Evals
Security

Quality

Content

77%

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

This is a well-structured, actionable skill with a clear multi-step workflow, concrete commands, and good error handling. Its main strengths are the explicit validation steps, user confirmation gates, and specific fallback behaviors. Minor weaknesses include some verbosity in step descriptions and the inability to verify referenced bundle files.

Suggestions

Trim parenthetical explanations after artifact names (e.g., '-- project overview, goals, key decisions') since Claude can infer purpose from file names and context.

Provide the referenced bundle files (doc-template.md, template-versioning.md) to support the progressive disclosure references in the skill body.

DimensionReasoningScore

Conciseness

The skill is mostly efficient and avoids explaining concepts Claude already knows, but there's some verbosity in the step descriptions that could be tightened. For example, the parenthetical explanations after artifact names (e.g., '-- project overview, goals, key decisions') add moderate value but could be trimmed. The pipeline position diagram and overall structure are lean.

2 / 3

Actionability

The skill provides concrete, executable commands (git diff commands with exact flags, specific file paths, mkdir -p), specific file names to read, clear decision criteria (e.g., 'fewer than 15 changed files AND 3 or fewer phases'), and exact user prompts to display. The guidance is specific enough to be directly followed.

3 / 3

Workflow Clarity

The 7-step workflow is clearly sequenced with explicit validation checkpoints (Step 7 verifies file paths and class/function names exist), user confirmation gates (Step 2's missing reports prompt), and clear fallback paths (e.g., git not available, no spec found). Error handling is comprehensive with specific recovery actions for each failure mode.

3 / 3

Progressive Disclosure

The skill references external files (doc-template.md, template-versioning.md) which is good progressive disclosure, but no bundle files were provided to verify these references exist. The skill itself is somewhat long and could potentially split the error handling or git analysis into reference files. However, the content is well-organized with clear section headers.

2 / 3

Total

10

/

12

Passed

Description

89%

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 strong skill description with excellent trigger term coverage and clear scoping to Arness pipeline projects. The explicit exclusion clause ('Do NOT use this for general-purpose documentation') and numerous trigger phrases make it highly distinguishable. The main weakness is that the specific output actions could be more concrete — what kind of documentation is produced (e.g., markdown files, API references, changelogs)?

Suggestions

Specify the concrete output format or documentation types produced (e.g., 'generates markdown developer docs including summary, changes made, and technical details' rather than just 'produce accurate documentation').

DimensionReasoningScore

Specificity

The description names the domain (developer documentation for Arness pipeline projects) and mentions some actions like reading plan artifacts, spec files, execution reports, and git diffs, but the concrete output actions are somewhat vague — 'produce accurate documentation' doesn't specify what form the documentation takes (e.g., README, API docs, changelog entries).

2 / 3

Completeness

Clearly answers both 'what' (reads plan artifacts, spec files, execution reports, and git diff to produce developer documentation) and 'when' (explicit trigger phrases and use-case guidance, plus a clear exclusion of general-purpose documentation). The 'Use when' is effectively conveyed through the opening clause and trigger terms.

3 / 3

Trigger Term Quality

Excellent coverage of natural trigger terms including 'document project', 'generate docs', 'create documentation', 'write docs', 'document this feature', 'document this fix', plus the specific internal identifiers like 'arness code document' and 'arn-code-document-project'. These are terms users would naturally say.

3 / 3

Distinctiveness Conflict Risk

Highly distinctive — scoped specifically to 'Arness pipeline projects' with explicit exclusion of general-purpose documentation. The unique trigger terms like 'arn-code-document-project' and 'arness code document' make it very unlikely to conflict with other documentation skills.

3 / 3

Total

11

/

12

Passed

Validation

90%

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

Validation10 / 11 Passed

Validation for skill structure

CriteriaDescriptionResult

frontmatter_unknown_keys

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

Warning

Total

10

/

11

Passed

Repository
AppsVortex/arness
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.