skills.rest
acedergren
acedergrenCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-sync

Audit repository documentation against code to identify drift and inconsistencies.

Updated Aug 27, 2026
Search Tags:#documentation#codebase#audit#monorepo#drift#quality-assurance
One-click install
npx skills add https://github.com/acedergren/oci-self-service-portal --skill doc-sync-acedergren
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/acedergren/oci-self-service-portal/tree/main/.claude/skills/doc-sync
Command: npx skills add https://github.com/acedergren/oci-self-service-portal --skill doc-sync-acedergren

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps repository documentation in sync with the actual codebase, preventing drift that can mislead reviewers and stakeholders.

Core Features & Use Cases

  • Drift detection: compares docs/ARCHITECTURE.md, docs/SECURITY.md, docs/TESTING.md, and docs/ROADMAP.md with the corresponding code structure.
  • Remediation planning: generates a remediation plan and highlights changes to propose in a PR.
  • Audit readiness: ensures documentation reflects current architecture, security posture, tests, and roadmap.

Quick Start

Run the doc-sync audit to identify and fix documentation drift in the repository.

Frequently Asked Questions about doc-sync

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

FAQPage Schema
How do I detect documentation drift in a monorepo codebase?▼

Documentation drift in a monorepo is detected by auditing files like ARCHITECTURE.md and SECURITY.md against the actual repository structure to identify inconsistencies and report drift items.

What is the best way to audit project documentation before a pull request?▼

Auditing project documentation before a PR involves comparing roadmap, testing, and architecture docs against codebase changes to ensure alignment and generate a remediation plan for proposed updates.

How does documentation audit for codebase alignment work?▼

Documentation audit for codebase alignment works by verifying architecture, security, testing, and roadmap references against the actual repository structure to highlight inconsistencies and propose necessary changes.

Can I use a documentation drift audit for standard monorepo docs paths?▼

Yes, you can apply a documentation drift audit to monorepos containing docs under specific paths like docs/ARCHITECTURE.md, docs/SECURITY.md, docs/TESTING.md, and docs/ROADMAP.md.

When do I need to run a documentation parity check?▼

You need to run a documentation parity check after major codebase changes or before PRs to ensure repository documentation reflects the current architecture, security posture, and testing setup.

What should I do after identifying documentation inconsistencies in my repository?▼

After identifying documentation inconsistencies, you should review the generated remediation plan to fix drift items and propose documentation updates in a pull request.

Related Skills

Explore More Software Engineering Skills→
kvnxiaokvnxiao

docs-generator

Audit codebases and generate CLAUDE.md with a structured docs/ directory.

Community
Advanced
OmexITOmexIT
13

tech-debt-assessment

Identifies, inventories and prioritizes technical debt across code, architecture, testing, infra, and docs to produce a repayment roadmap with ownership and timelines.

Community
Advanced
nicolanoviellnicolanoviell
2

code-review

Review code changes for bugs, style issues, and best practices.

Community
Intermediate
amiable-devamiable-dev
1

Template Registry Management

Validate and manage templates.yaml registry entries with schema checks.

Community
Advanced