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.

79

Quality

100%

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

100%Weight 40%Scale 1-3

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

A well-structured, executable workflow with concrete commands, explicit validation checkpoints, and appropriate offloading of detail to real, one-level-deep reference files. Concise and actionable with no padded explanations.

DimensionReasoningScore

Conciseness

Lean and action-oriented throughout — it assumes Claude's competence, states exact paths and commands, and avoids explaining concepts Claude already knows, so every token earns its place.

3 / 3

Actionability

Provides concrete executable commands (git merge-base, git diff --stat/--name-status, mkdir -p), exact file/path conventions, and a referenced template, giving copy-paste-ready guidance rather than abstract direction.

3 / 3

Workflow Clarity

A clearly sequenced 7-step workflow with explicit validation checkpoints — an AskUserQuestion gate when reports are missing (Step 2) and a verify-then-report loop in Step 7 — matching the feedback-loop anchor.

3 / 3

Progressive Disclosure

The body is a concise overview that offloads detail to a one-level-deep, clearly-signaled reference (doc-template.md, verified present) and an external template-versioning.md reference, with content appropriately split.

3 / 3

Total

12

/

12

Passed

Description

100%Weight 40%Scale 1-3

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, third-person description with explicit trigger phrases, a clear what-and-when statement, and a distinct niche bounded by a negative-scope clause. No significant weaknesses in any dimension.

DimensionReasoningScore

Specificity

Lists multiple concrete actions in third person — "Reads plan artifacts, spec files, execution reports, and git diff to produce accurate documentation" — matching the top anchor rather than the domain-only level 2.

3 / 3

Completeness

Explicitly answers both what it does and when to use it via "This skill should be used when the user says ...", with an explicit negative-scope guard ("Do NOT use ... for general-purpose documentation").

3 / 3

Trigger Term Quality

Covers natural phrasings a user would actually say ("document project", "generate docs", "create documentation", "write docs", "document this feature", "document this fix") plus the skill id, giving good keyword coverage.

3 / 3

Distinctiveness Conflict Risk

Clearly scoped to "Arness pipeline projects" and actively disclaims general-purpose documentation use, giving it a distinct niche unlikely to trigger for the wrong skill.

3 / 3

Total

12

/

12

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.

Validation15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

frontmatter_unknown_keys

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

Warning

Total

15

/

16

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.