CtrlK
BlogDocsLog inGet started
Tessl Logo

update-docs

Audit and update documentation after code changes. Use when architecture, APIs, or behavior changed and docs may have drifted.

81

1.03x
Quality

73%

Does it follow best practices?

Impact

95%

1.03x

Average score across 3 eval scenarios

SecuritybySnyk

Passed

No known issues

Optimize this skill with Tessl

npx tessl skill review --optimize ./.claude/skills/update-docs/SKILL.md
SKILL.md
Quality
Evals
Security

Update docs

Docs rot when code moves faster than prose. After a code change, check if the docs still describe reality. Fix what drifted. Skip what didn't.

If agent teams are available, create an agent team for each major section of the documents.

Where to look

README.md is the SSOT. Use /related-repositories for dependent repos.

LocationContents
README.mdEpics, repositories, Helm charts, infra, people
docs/design-documents/Architecture (indexing, querying, data model, security, observability)
docs/dev/Local setup, infrastructure, runbook
CLAUDE.md / AGENTS.mdAgent context. Must stay identical — CI enforces this.
crates/*/README.mdPer-crate docs
crates/indexer/AGENTS.mdIndexer agent context
skills/orbit/Agent skill for Knowledge Graph queries. SKILL.md, references/recipes.md, references/troubleshooting.md are hand-written and need updates when API behavior or response shape changes. references/query_language.md is byte-equal-synced from docs/source/queries/ (CI-enforced via orbit-skill-docs-sync, no manual action needed).

Gathering context

Before editing, research what changed and what the current state looks like:

git log --oneline --since="2 weeks ago" -- crates/query-engine/compiler/
glab issue list --label "knowledge graph" --state opened
glab mr list --state merged --per-page 20

Use glab to check epics, issues, and MRs for context on what shipped recently. Cross-reference against what the docs say.

What drifts most

  • New ontology entities missing from data_model.md
  • Query engine changes not in querying/graph_engine.md
  • New CDC topics or handlers missing from indexing/sdlc_indexing.md
  • Security model changes not in security.md
  • Crate renames, splits, or new crates not reflected in CLAUDE.md
  • People or epic changes not in README.md
  • Stale config references in docs/dev/runbooks/server_configuration.md
  • New orbit API endpoints, query types, response-format changes, or user-visible features (e.g. indexing progress added in !1015) not reflected in skills/orbit/SKILL.md, references/recipes.md, or references/troubleshooting.md. CI only enforces byte-equal sync of query_language.md — the rest of the skill's hand-written prose (discovery workflow, recipes, gotchas, agent guidelines) won't flag itself as stale.

Fixing

  1. Read the stale doc
  2. Read the code it describes
  3. Edit the doc to match
  4. Run mise run lint:docs to validate
  5. If you touched CLAUDE.md, mirror the change to AGENTS.md
  6. If your change alters orbit API behavior (new endpoint, new query type, new response field, new user-visible feature), update skills/orbit/SKILL.md and skills/orbit/references/ (especially recipes.md and troubleshooting.md) to reflect it. CI only catches byte-equal drift of query_language.md; everything else in the skill is manual.

Self-improvement

When you find drift this skill doesn't cover, add it to "What drifts most" above. If the user provides feedback about missing documentation updates that the agent didn't catch, add it to this skill.

Repository
gitlabhq/orbit-knowledge-graph
Last updated
Created

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.