CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

beads-docs

Project conventions for writing, editing, restructuring, or reviewing the beads user documentation — the Mintlify site under docs/. Use this whenever you touch anything in docs/ (pages, concept docs, reference, integration guides, recovery runbooks, diagrams, docs.json navigation) or write/edit prose about beads, even when the request is just "fix the docs", "write a docs page", "the docs are wrong/confusing", "rename X across the docs", or an edit to a file under docs/. It defines the canonical concept model (bead → dependencies → ready work; formula → proto → molecule/wisp; gates; Dolt sync and federation), required terminology, the prose/emphasis/diagram conventions, the rule that generated docs are edited at their source, and the gates to run before docs work is done.

76

Quality

96%

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

92%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 high-quality conventions skill: every claim is anchored to concrete paths, commands, or literal strings, workflows end in explicit gates with recovery loops, and detail is properly offloaded to three real one-level-deep reference files. The only weakness is mild duplication between the concept-model and terminology tables and a few passages that could be tightened.

DimensionReasoningScore

Conciseness

The body is dense, assumes Claude's competence (no primer on Mintlify, git, or Markdown), and stores information in cheap carriers (tables, arrow pipelines, command lists). It falls just short of the top anchor because the §1 concept table and §2 terminology table restate overlapping material (molecule/wisp/formula/proto/sync appear in both), and a few passages (§8's generated-content provenance, the Gas City paragraph) could be trimmed slightly without loss.

4 / 5

Actionability

Guidance is copy-paste executable throughout: exact commands (`go test ./test/docsync`, `./scripts/generate-cli-docs.sh --check`, `make docs-dev`, `make diagrams-excalidraw`), exact file paths (`.beads/embeddeddolt/` vs `.beads/dolt/`, `docs/cli-docs.pin`), and a use/not-this terminology table with precise exceptions. This matches the anchor for fully executable, command-ready guidance covering the common cases.

5 / 5

Workflow Clarity

The multi-step processes are explicitly sequenced with validation: §9 lists the verification gates to run before work is done, §10 sequences author → maintainer review → commit on approval, and the page-move/remove procedure includes its full recovery loop (add redirects, grep inbound links, check whether bd prints the old path, fix Go source and regenerate). Failure behavior is stated (drift gates fail or auto-fix hand edits), satisfying the feedback-loop expectation for batch-style repo-wide edits.

5 / 5

Progressive Disclosure

The SKILL.md is a well-sectioned overview (§1–§10) with three references, each one level deep, well-signaled from the section that needs it (terminology.md for the rename discipline, simplification.md for trim passes, verification.md for the full gate list), and all three exist as real, on-topic files with no nested references. The detail that belongs inline (canonical model, terminology rules) is inline; per-procedure detail is correctly split out.

5 / 5

Total

19

/

20

Passed

Description

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

An exemplary description: concrete actions, an explicit and generously illustrated 'use when' clause in third person, and a clearly bounded niche. Every clause is either a trigger, a scope boundary, or a statement of contents — no padding despite its length.

DimensionReasoningScore

Specificity

"Project conventions for writing, editing, restructuring, or reviewing the beads user documentation" lists four concrete actions, and it goes on to enumerate exactly what it defines (canonical concept model, required terminology, prose/emphasis/diagram conventions, generated-docs source rule, verification gates). Coverage is comprehensive with no generic filler.

5 / 5

Completeness

The 'what' is explicit (conventions governing the concept model, terminology, prose/diagram style, generated-content rules, and gates) and the 'when' is explicit and concrete ("Use this whenever you touch anything in docs/… even when the request is just 'fix the docs'"), matching the anchor that clearly answers both what and when with concrete trigger phrases.

5 / 5

Trigger Term Quality

Natural trigger phrases are quoted verbatim — "fix the docs", "write a docs page", "the docs are wrong/confusing", "rename X across the docs" — alongside concrete artifacts users would mention (pages, reference, integration guides, recovery runbooks, diagrams, docs.json navigation, Mintlify). This covers synonyms and literal user phrasings comprehensively.

5 / 5

Distinctiveness Conflict Risk

The niche is tightly bounded — the Mintlify site under docs/ for the beads project, explicitly distinguished from contributor-facing material — and the triggers (beads, bd, docs.json, docs/) are distinct tokens unlikely to fire a different skill. Even the broadened claim ("fix the docs") stays anchored to files under docs/.

5 / 5

Total

20

/

20

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.

Validation — 15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

referenced_paths_exist

Referenced path issues: 1 missing

Warning

Total

15

/

16

Passed

Repository

gastownhall/beads

Path

.claude/skills/beads-docs/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.