agentsclimarketplace

Plan docs sync

Skill kensaurus/cursor-kenji/skills/plan-docs-sync

🦖Curated Cursor AI agent skills, slash commands, MCP configs, subagents & rules for full-stack dev — React 19, Next.js 15, Supabase, Tailwind v4, TypeScript

Install
npx -y skills add kensaurus/cursor-kenji --skill plan-docs-sync

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 6 stars6 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Audit documentation against actual code behavior and plan corrections — no rewrites in this pass. Drift taxonomy (stale, missing, phantom, contradictory, onboarding-breaking, inline rot, API-contract drift) with code-as-source-of-truth methodology. Onboarding-drift checks against .env.example and CLI --help; docs-as-code guardrails for same-PR updates. Docs describe real current behavior — never aspirational or invented. Use when asked to "docs drift", "sync docs with code", "audit documentation", "stale README", "onboarding docs broken", "doc sync plan", "phantom docs", or "docs out of date".

The file declares its own license as MIT. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.

SKILL.md

3.7 KB, 791 tokens by cl100k_base, as published. Nobody here has run it

Docs Drift Audit + Sync Plan

Role: Senior engineer + technical writer.

Task: Audit all documentation against what the code actually does, find every drift, plan corrections. README, CONTRIBUTING, setup/onboarding, API docs, JSDoc/docstrings, architecture notes, .env.example, CLI --help, changelogs. Audit & plan only.

This skill vs neighbors

SkillDoes
plan-docs-sync (this)Plan doc corrections from code truth
docs-writerWrite/improve docs (execution)
workflow-housekeepREADME refresh as part of housekeeping
plan-stub-checkerStubs/dead UI — often surfaces phantom docs

Loop position: run last in the six-skill plan loop. See docs/PLAN-LOOPS.md.


â›” Preservation Contract

Read references/preservation-contract.md. Acknowledge in output #1.

Core guardrail: docs describe real, current behavior — never aspirational or invented.


References

FileContents
references/drift-taxonomy.mdTypes, detection passes, guardrails
references/output-templates.mdBurndown, phased sync plan

Phase flow

1. Inventory all doc surfaces
2. Code-as-source-of-truth pass
3. Reverse pass (missing docs)
4. Onboarding replay (.env.example + CLI help)
5. Signature + cross-doc consistency + links
6. Burndown + phased sync plan
7. Research + guardrails (docs-as-code, CI drift checks)

Phase 1 — Doc inventory

Glob: README.md CONTRIBUTING.md docs/**/*.md **/*README*.md
Glob: .env.example

List: README, CONTRIBUTING, docs/, inline JSDoc targets, OpenAPI, CLI help, changelog.


Phase 2–5 — Detection

Execute all passes in references/drift-taxonomy.md.

Onboarding-drift check (standout): extract env var names + setup commands from onboarding docs; diff against .env.example keys and package.json scripts; run CLI --help where safe and compare.

Every drift: doc claim + code truth (path:line). Can't verify → [NEEDS VERIFICATION].


Phase 6 — Burndown + sync plan

Template: references/output-templates.md

Quantify: e.g. "9 phantom env vars, 14 undocumented endpoints, 6 onboarding steps that fail".

Per drift: before/after correction + "what's still accurate here". Plan only — no rewrites until approval.

Industry enhancements (Firecrawl, current year): docs-as-code, doc-in-same-PR, CI drift vs .env.example + CLI help, generated API refs, llms.txt.


Required output (in order)

  1. Preservation-contract acknowledgment
  2. Drift taxonomy results (counts per type)
  3. Per-doc drift inventory (checklist)
  4. Burndown table (code-truth + risk)
  5. Sync + enhancement plan, phased
  6. Guardrails/tooling
  7. Research notes + citations
  8. Open questions / [NEEDS VERIFICATION] list

Rules

  • Plan only — do not rewrite docs until approved.
  • Code is source of truth. Every drift = doc claim + code fact.
  • Never document invented or aspirational behavior.
  • Stale docs get corrected, not deleted. Deletions are proposals.
  • Separate factual drift vs subjective wording improvement.

What ships with it: 3 files

3.5 KB alongside SKILL.md

Keep looking

Skills are one crate of 326,970. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.