CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

codebase-wiki

How to work in a Codebase Wiki project (the `codebase-wiki` starter pack): an agent-authored, source-grounded wiki of the surrounding codebase. Read when the project has a `wiki/` knowledge base with `architecture/`, `modules/`, `flows/`, `concepts/`, and `guides/` sections plus `wiki/OVERVIEW.md`, or when asked to generate or refresh a wiki of this codebase. Carries the per-folder rules and freshness + log discipline, summarizes the audience/depth knobs and source-reference convention, and bundles the full generate/refresh procedure in `references/`. Complements the platform `open-knowledge` skill; does not replace it.

Quality

85%

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

78%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 pack overview: pack-specific, competent-assuming, and correctly split between a lean SKILL.md and one authoritative reference. The main improvement room is trimming the source-reference-convention detail duplicated from the reference, and briefly surfacing the refresh/validation failure-handling instead of leaving it entirely in the referenced file.

DimensionReasoningScore

Conciseness

The body is dense with pack-specific detail and assumes Claude's competence (no explanations of what a wiki, mermaid, or git HEAD is); every section carries rules Claude could not infer. Not a 5 because the source-reference convention section repeats implementation detail (brokenLinks `no-such-file`/`unresolvable` behavior, `../` hop counting) that the body itself says fully "lives in references/generate-and-refresh.md", so a few sentences could be trimmed without loss.

4 / 5

Actionability

Concrete, executable guidance throughout: the exact `wiki/` directory shape, mode-detection rule ("a stubbed `OVERVIEW.md` (empty `source_commit`) → generate... a stamped `source_commit` → refresh"), toolset routing rules, a copy-paste log-entry markdown template, template names with the exact call `write({ document: { path, template: "<name>" } })`, and knob value enumerations. Not a 5 because the full operational procedure is deliberately delegated to the reference, so some specifics (OK verb syntax, phase steps) are absent from the body itself.

4 / 5

Workflow Clarity

The generate sequence is summarized inline ("survey → overview → architecture → modules → flows → concepts → link-graph audit") with refresh as a diff-driven counterpart, STOP-gating and the link-graph audit are named, and two MUST-discipline sections (always re-stamp `source_commit`, one log entry per run) act as explicit checkpoints for this batch-write workflow. Not a 5 because the explicit validation steps and error-recovery loops (e.g. brokenLinks handling on failure, what to do when the Hocuspocus server is down) live in the reference rather than being surfaced even briefly in the body.

4 / 5

Progressive Disclosure

Textbook structure: SKILL.md is a lean overview (folder shape, knobs, conventions, MUST disciplines) with the full procedure split into a single one-level-deep reference, `references/generate-and-refresh.md` (verified present), clearly and repeatedly signaled via markdown links at each relevant section. Templates are described without inlining their content, and the body explicitly avoids repeating full details it delegates.

5 / 5

Total

17

/

20

Passed

Description

87%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 description: explicit dual trigger conditions, concrete capability inventory, third-person voice, and explicit non-conflict boundary with the platform open-knowledge skill. The only softness is that a few capabilities are phrased as document contents rather than agent actions, and a couple of natural synonyms (e.g. "documentation") are missing.

DimensionReasoningScore

Specificity

The description names concrete capabilities: "generate or refresh a wiki of this codebase", "Carries the per-folder rules and freshness + log discipline, summarizes the audience/depth knobs and source-reference convention, and bundles the full generate/refresh procedure in `references/`" — several specific actions with minor gaps. Not a 5 because some capabilities are stated as what the document contains ("carries", "summarizes", "bundles") rather than actions the agent performs, leaving coverage slightly less direct than the comprehensive anchor.

4 / 5

Completeness

Both what and when are explicit: "How to work in a Codebase Wiki project... an agent-authored, source-grounded wiki of the surrounding codebase" (what) and "Read when the project has a `wiki/` knowledge base with... or when asked to generate or refresh a wiki of this codebase" (when, with two concrete trigger conditions). Matches the top anchor with concrete trigger phrases; the neighboring 4 anchor ("'when' could be more explicit") fits less well since the when-clause is fully explicit.

5 / 5

Trigger Term Quality

Natural terms a user would say are present: "wiki", "generate or refresh a wiki", "knowledge base", "codebase", plus concrete path markers ("wiki/OVERVIEW.md", "architecture/", "modules/", "flows/"). Not a 5 because common synonyms like "documentation" or "docs" and DeepWiki-style phrasing are absent, so a few natural variations users might say are not covered.

4 / 5

Distinctiveness Conflict Risk

Clear niche — the very specific `wiki/` layout trigger and the explicit boundary "Complements the platform `open-knowledge` skill; does not replace it" minimize conflict risk with the closest related skill. Matches the top anchor for clear distinct triggers and minimal conflict.

5 / 5

Total

18

/

20

Passed

Validation

87%

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

Validation — 14 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

metadata_version

'metadata.version' is missing

Warning

relative_links

Relative link issues: 3 missing

Warning

Total

14

/

16

Passed

Repository

inkeep/open-knowledge

Path

packages/server/assets/skills/packs/codebase-wiki/SKILL.md

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.