doc-sync

Synchronize project documentation with implementation changes by editing Tier 1 files and logging deltas.

1|1|Updated Nov 20, 2025
One-click install
npx skills add https://github.com/estebandegetau/Fiscal-shocks --skill doc-sync-estebandegetau
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/estebandegetau/Fiscal-shocks/tree/main/.claude/skills/doc-sync
Command: npx skills add https://github.com/estebandegetau/Fiscal-shocks --skill doc-sync-estebandegetau

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill reduces documentation drift by detecting implementation changes and ensuring project documentation accurately reflects the current codebase state, minimizing stale facts and missed updates.

Core Features & Use Cases

  • Auto-update machine context: Read and minimally edit Tier 1 files such as CLAUDE.md and notebooks/CLAUDE.md to reflect concrete status changes (stage gates, active notebooks, pipeline targets).
  • Delta logging for human specs: Append structured entries to docs/deltas.md when implementation reveals corrections, validations, or new constraints that require human review.
  • Tiered safety rules: Never edit Tier 2 specification files directly, treat Tier 3 references as ignored, and nudge strategy reconciliation when unresolved deltas accumulate.
  • Use case: After adding new R functions and changing targets in _targets.R, run a doc-sync pass to update the CLAUDE.md status lines and record any specification deltas.

Quick Start

Ask the assistant to perform a full documentation sync by saying /doc-sync.

Frequently Asked Questions about doc-sync

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

FAQPage Schema
How do I keep project documentation consistent with code changes in an R research pipeline?

Documentation drift is reduced by reading git status and parsing _targets.R to detect implementation changes, then minimally updating CLAUDE.md status files and appending structured delta logs for human review.

How do I update CLAUDE.md automatically when R targets change?

To update CLAUDE.md after R targets change, run a sync pass that scans your project directories and applies minimal edits to Tier 1 context files to reflect updated stage gates and active pipeline targets.

Does doc-sync work with Quarto notebooks and R targets pipelines?

Yes, this Skill works with Quarto notebooks and R targets pipelines by parsing _targets.R, scanning notebooks/ and R/ directories, and updating Tier 1 context files to reflect the current research codebase state.

What is the best way to log specification deltas during active development?

The best way to log specification deltas is appending structured entries to docs/deltas.md when implementation reveals corrections or new constraints, ensuring human review without directly editing Tier 2 specification files.

When should I avoid automated documentation updates in a research codebase?

You should avoid automated documentation updates for Tier 2 specification files, as the Skill enforces tiered safety rules that never edit specifications directly and instead nudges strategy reconciliation when unresolved deltas accumulate.