code-wiki

Generate wiki docs + Mermaid diagrams for any codebase.

Quality

71%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Low

Low-risk findings worth noting

Fix and improve this skill with Tessl

tessl review fix ./optional-skills/software-development/code-wiki/SKILL.md

Quality

Content

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

This is a strong, highly actionable skill body: concrete commands and templates for every step, explicit scope bounding, an excellent pitfalls list, and a real verification pass with feedback loops. The only structural improvement is moving the bulky per-file output templates into a references/ directory to slim the always-loaded SKILL.md.

Dimension	Reasoning	Score
Conciseness	The body is dense and nearly every section earns its place — commands, templates, pitfalls, scope control — with only minor over-explanation ("Inspired by Google CodeWiki", a few explanatory asides) that could be trimmed.	4 / 5
Actionability	Every step ships copy-paste-ready bash, complete markdown output templates, concrete Mermaid syntax rules (shape semantics, quoting, generics), and an executable verification script — fully executable guidance covering the common cases.	5 / 5
Workflow Clarity	A 12-step quick-reference table is expanded into a detailed procedure, with a Scope Control section bounding cost and a Verification section providing four explicit validation checks (fence balance, file existence, module count, link resolution) that catch errors before reporting.	5 / 5
Progressive Disclosure	No bundle files exist, so everything is inline; the single file is nonetheless well-sectioned with a quick-reference table and clear navigation. The per-file output templates occupy a large share of the 445 lines and could be split into references/, leaving minor organization gaps.	4 / 5
	Total	18 / 20 Passed

Description

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

The description delivers a clear, compact "what" with a distinct niche, but stops short of a full capability list and entirely lacks "when to use" trigger guidance. Adding a "Use when..." clause with the natural user phrasings already enumerated in the body's "When to Use" section would lift most dimensions at once.

Suggestions

Append a 'Use when' clause mirroring the body's triggers, e.g. "Use when the user asks to document a codebase, generate a wiki, or make architecture diagrams, or points at a GitHub URL and asks for documentation."

List the concrete outputs more comprehensively: overview, architecture doc, per-module deep-dives, and Mermaid class/sequence diagrams — not just 'wiki docs + Mermaid diagrams'.

Include a couple of natural synonyms users would say ("document this repo", "onboarding docs", "architecture diagrams") to broaden trigger coverage.

Dimension	Reasoning	Score
Specificity	"Generate wiki docs + Mermaid diagrams for any codebase" names the domain plus two concrete actions, but omits the skill's other outputs visible in the body (architecture docs, per-module deep-dives, class and sequence diagrams), so coverage is incomplete.	3 / 5
Completeness	The "what" is clear, but there is no "Use when..." clause or equivalent explicit trigger guidance, which caps completeness at 3.	3 / 5
Trigger Term Quality	Relevant keywords are present ("wiki", "docs", "Mermaid", "diagrams", "codebase") but common natural phrasings users would say — "document this codebase", "generate a wiki", "architecture diagrams", "onboarding" — are missing.	3 / 5
Distinctiveness Conflict Risk	The wiki/Mermaid-generation niche is mostly distinct from other skills, with only minor overlap risk against adjacent codebase-inspection or general documentation skills.	4 / 5
	Total	13 / 20 Passed

Validation

75%

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 — 12 / 16 Passed

Validation for skill structure

Criteria	Description	Result
metadata_version	'metadata.version' is missing	Warning
metadata_field	'metadata' should map string keys to string values	Warning
frontmatter_unknown_keys	Unknown frontmatter key(s) found; consider removing or moving to metadata	Warning
relative_links	Relative link issues: 13 missing	Warning

	Total	12 / 16 Passed

Repository: NousResearch/hermes-agent
Path: optional-skills/software-development/code-wiki/SKILL.md
Commit: 68fa7e9

Reviewed: 3 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.