docguard-sync

Sync DocGuard-owned documentation sections with current codebase state.

Updated Mar 16, 2026

Search Tags:#documentation #developer workflow #api reference #documentation drift #codebase synchronization #docguard #human prose review

Ready to run

npx skills add https://github.com/B0yZ4kr14/OrthoPlus-Enterprise --skill docguard-sync

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docguard-sync
Source: https://github.com/B0yZ4kr14/OrthoPlus-Enterprise/tree/main/.agent/skills/docguard-sync
Command: npx skills add https://github.com/B0yZ4kr14/OrthoPlus-Enterprise --skill docguard-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires docguard-cli.

What problem does it solve?

It prevents documentation from drifting away from the real code by re-deriving the code-truth sections from the current repository state while prompting you to update only the human-written prose that must stay accurate.

Core Features & Use Cases

Refresh code-truth documentation: Re-renders owned doc sections (like endpoints, entities, screens, tech stack, and env vars) in place using DocGuard’s deterministic mechanical regeneration.
Identify prose that needs human attention: Flags the specific human-written source=human sections that may no longer match the refreshed reality after code changes.
Safe, review-first workflow: Runs in a dry-run preview mode to show what would change before you apply updates.

Quick Start

Run the sync command to preview and then update stale documentation by running DocGuard in dry-run mode first, then in write mode.

Frequently Asked Questions about docguard-sync

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

FAQPage Schema

How do I keep API reference documentation in sync with my codebase?▼

To keep API reference documentation in sync, run a preview dry-run to re-derive code-truth sections from the current repository, then apply the write phase to update the canonical docs safely.

What is documentation drift and how do I identify affected human prose?▼

Documentation drift occurs when code changes outpace manual updates. You identify affected human prose by running a sync preview that flags specific source=human sections no longer matching refreshed reality.

Can I use git-diff context to limit documentation synchronization to recent changes?▼

Yes, you can use git-diff context to limit documentation synchronization by passing the --since flag, restricting the re-derivation of code-truth sections to only recent codebase modifications.

Do I need the docguard-cli installed to sync documentation?▼

Yes, you need the docguard-cli installed to execute the sync preview and write phases, which rely on the CLI to enforce section ownership markers and validate against documentation generation errors.

What is the best way to safely update stale architecture overviews?▼

The best way to safely update stale architecture overviews is running a review-first dry-run mode that mechanically regenerates owned doc sections before applying the final write phase.

When should I not use automated documentation synchronization?▼

You should not use automated documentation synchronization for sections lacking ownership markers, as the guard validation requires these boundaries to prevent overwriting manual human prose blocks.