ubuntu-helm-docs

Generate or update README.md documentation for Helm charts in this project. Extracts all values from values.yaml, describes deployed resources, and produces a complete README with architecture, installation, configuration table, and upgrade sections. Use when: documenting a chart, generating a README, updating docs after adding features or values. Trigger phrases: "document chart", "generate README", "update docs for chart", "generate documentation", "write README for chart".

Quality

89%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Quality

Content

82%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.

A well-structured, highly actionable skill body with executable commands, a concrete README scaffold, and a verification checklist. Weakest in explicit feedback loops and in splitting out the optional-section guidance into reference material.

Suggestions

Make the validation feedback loop explicit in the Quality checks section — e.g. 'If any check fails, return to Step 5 to fill missing descriptions or Step 3 to capture missing resources, then re-verify.'

Pull the optional-section guidance (TLS, Prometheus metrics, persistence, high availability) into a references/ file and link to it one level deep, keeping SKILL.md as a lean overview.

Tighten the README template by removing the escaped-backtick scaffolding redundancy and referencing the Step 1 values table directly rather than re-stating the table header in Step 4.

Dimension	Reasoning	Score
Conciseness	The body is lean and assumes Claude's competence (no explanations of Helm/Kubernetes concepts), but the full README template block with escaped backticks and minor redundancy between the Step 1 table example and the Step 4 table could be trimmed slightly.	4 / 5
Actionability	Provides fully executable, copy-paste-ready commands ('bash scripts/generate-documentation.sh', 'helm install my-<chart-name> <chart-path>/', 'helm upgrade'), names exact files to read (Chart.yaml, templates/), and gives concrete examples for filling inferred descriptions, covering the common cases.	5 / 5
Workflow Clarity	Steps 1–5 are clearly sequenced and a 'Quality checks' checklist provides verification checkpoints, but the feedback loop (e.g. 'if a description is still empty/inferred, return to Step 5') is implicit rather than an explicit error-recovery loop.	4 / 5
Progressive Disclosure	Well-organized into Prerequisites/Workflow/Quality checks with real, clearly-signaled one-level-deep script references (scripts/setup.sh, scripts/generate-documentation.sh both exist), but optional-section guidance (TLS, metrics, persistence) is only briefly inlined with no separate reference material, leaving minor organization gaps.	4 / 5
	Total	17 / 20 Passed

Description

92%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, specific description that clearly states what the skill does and when to use it, with concrete chart-scoped trigger phrases. The only gap is trigger-term breadth — no file extensions and 'Helm' is absent from the trigger phrases themselves.

Dimension	Reasoning	Score
Specificity	Lists multiple concrete actions — 'Extracts all values from values.yaml, describes deployed resources, and produces a complete README with architecture, installation, configuration table, and upgrade sections' — giving comprehensive coverage of what the skill does.	5 / 5
Completeness	Explicitly answers both 'what' (generate/update README, extract values, describe resources, produce named sections) and 'when' ('Use when: documenting a chart, generating a README, updating docs after adding features or values') with concrete trigger phrases.	5 / 5
Trigger Term Quality	Provides natural trigger phrases users would say ('document chart', 'generate README', 'update docs for chart', 'write README for chart') with synonyms, but omits file extensions and the word 'Helm' does not appear in the trigger phrases, leaving a few natural terms missing.	4 / 5
Distinctiveness Conflict Risk	Scoped to 'Helm charts in this project' with chart-specific triggers ('document chart', 'write README for chart'), giving it a clear niche with minimal overlap risk against general documentation skills.	5 / 5
	Total	19 / 20 Passed

Validation

93%

Warnings & errors only

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

Criteria	Description	Result
frontmatter_unknown_keys	Unknown frontmatter key(s) found; consider removing or moving to metadata	Warning

	Total	15 / 16 Passed

Repository: canonical/helm-charts
Path: .agents/skills/ubuntu-helm-docs/SKILL.md
Commit: 78b355b

Reviewed: 6 days ago

Table of Contents

Discovery Implementation Validation

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.