skills.rest
zero-rehq
zero-rehqCOMMUNITY
Explore all skills by this author →
GitHub

documentation-sync

Detect and report drift between code and documentation across README files, docs, examples, and architecture diagrams.

Updated Jan 15, 2026
Search Tags:#documentation#validation#drift#README#CHANGELOG#docs-sync#detect
One-click install
npx skills add https://github.com/zero-rehq/opencode-kit --skill documentation-sync-zero-rehq
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-sync
Source: https://github.com/zero-rehq/opencode-kit/tree/main/.opencode/skill/documentation-sync
Command: npx skills add https://github.com/zero-rehq/opencode-kit --skill documentation-sync-zero-rehq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill detects drift between code and documentation. It validates that README files, docs/, code examples, API signatures, and architecture diagrams reflect the current codebase, reducing misalignments and confusion.

Core Features & Use Cases

  • Drift detection across README files, docs/ directories, code examples, and architecture diagrams
  • Validation checks for API signatures, changelogs, and feature notes to ensure documentation accuracy
  • Drift reporting with severity levels and suggested fixes; supports auto-trigger in workflows and optional blocking in reviews

Quick Start

Run the documentation-sync workflow after making changes to code or docs to produce a drift report and guidance for fixes.

Frequently Asked Questions about documentation-sync

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

FAQPage Schema
How do I detect documentation drift between my code and README files?▼

Documentation drift detection works by performing structured comparisons between your codebase and your README files. It identifies misalignments in API signatures and examples, then produces a report with severity levels and suggested fixes.

What is the best way to validate API signatures against my existing docs?▼

Validating API signatures against docs requires structured comparisons of your code and documentation directories. This mechanism checks for misalignments in feature notes and API references, producing a drift report with severity levels and actionable fixes.

Can I automatically validate docs after an architectural refactor?▼

Yes, documentation validation supports auto-trigger after architectural refactors. It automatically compares your architecture diagrams and docs against the refactored code to report any resulting drift and suggest fixes.

Does documentation validation support blocking actions in code reviews?▼

Yes, documentation validation supports optional blocking actions in code reviews. You can configure the drift reporting to halt or block a workflow if critical misalignments between code and docs are detected.

How do I check if my architecture diagrams and examples match the current codebase?▼

To check if architecture diagrams and examples match the codebase, run a structured validation workflow. It validates that your diagrams and examples reflect the current code, reducing confusion by reporting any detected drift.

Related Skills

Explore More Content & Communication Skills→
michaelalbermichaelalber
2

doc-sync

Detect and correct documentation staleness in XML doc comments and README files.

Community
Advanced
jamie8johnsonjamie8johnson
13

docs-review

Detect documentation drift in Rust project files and repository metadata.

Community
Intermediate
arcasilesgrouparcasilesgroup
54

ai-pr

Automate governed pull request workflows with pre-push gates and squash merge.

Official
Advanced
CERTCCCERTCC
21

build-docs

Validate markdown documentation with strict mkdocs build checks.

Official
Intermediate