skills.rest
lldwb
lldwbCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-sync

Synchronizes documentation with actual code behavior using read-only subagent verification.

1|Updated Sep 11, 2026
Search Tags:#documentation#technical writing#verification#git commit#code consistency#doc sync#subagent review
One-click install
npx skills add https://github.com/lldwb/lldwb-claude-skills --skill doc-sync-lldwb
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/lldwb/lldwb-claude-skills/tree/main/skills/doc-sync
Command: npx skills add https://github.com/lldwb/lldwb-claude-skills --skill doc-sync-lldwb

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Documentation drifts out of sync with code as projects evolve, leaving outdated parameters, wrong examples, and descriptions of removed features that mislead developers. This Skill locates the code behind a document, confirms real behavior, updates only the affected sections, and verifies consistency with a read-only review subagent. ## Core Features & Use Cases - Two entry modes: Start from a document to find its code (update mode), or start from a change point to find all affected documents (correction mode). - Evidence-based editing: Every change must trace back to a code location (file:line) or a reproducible command output; unverifiable items go to a user confirmation list instead of being guessed. - Subagent consistency review: A read-only verification agent (references/verify-agent.md) cross-checks each claim against the fact source and returns a list of consistent items, inconsistencies, and documentation gaps. - Use Case: After refactoring an API's parameters, point the Skill at the API reference doc; it locates the implementation, diffs documented vs actual behavior, updates only the changed sections, and commits documentation-only changes. ## Quick Start Ask the agent to read the specified documentation, find the corresponding code, confirm the actual behavior, and sync the docs so they match the code.

Frequently Asked Questions about doc-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep documentation in sync with code changes?▼

Use a doc-sync workflow that locates the code behind each document, compares documented behavior against actual implementation line by line, and updates only the affected sections. A read-only subagent then verifies each claim against evidence before changes are committed.

How to find which docs are affected by a code change?▼

Start from the change point (modified modules, interfaces, or classes) and grep the documentation directory for references to those identifiers. The Skill reverse-maps code changes to all documents describing them, then lists each file with its specific update points.

Can this workflow handle non-code fact sources like configs or logs?▼

Yes, the verification subagent accepts any fact source: external repository docs, log output, configuration files, or session records. The same evidence requirements apply, with file paths and read-only command outputs replacing code line references.

When should I not use doc-sync for documentation updates?▼

Do not use it when documentation changes accompany code modifications or new features (use feature-dev instead), when the code itself has bugs to fix (use bug-fix), or when you only want an explanation of a concept without producing doc changes.

Does doc-sync modify code while updating documentation?▼

No, it only edits documentation files and commits documentation-only changes. If it discovers code defects during the sync process, it reports them separately and hands off to a bug-fix workflow rather than fixing them inline.

Related Skills

Explore More Software Engineering Skills→
tilework-techtilework-tech
149

Updating Noridocs

Update docs.md files after code changes using the nori-change-documenter subagent.

Official
Basic
tigredonortetigredonorte

create-jira-wiki

Publish Jira task design documents to a wiki repository.

Community
Advanced
wizelinewizeline

automating-docs-updates

Analyze Git code changes and update relevant documentation files.

Official
Intermediate
PeyPonsPeyPons

actualizar-documentacion-taimbox

Align modular docs/* with the DOCUMENTACION.md index after code changes.

Community
Intermediate