How does this skill identify which docs need updating?

It uses a predefined mapping system that correlates specific source directories and files to their corresponding documentation pages, allowing it to detect exactly which parts of the manual are affected by a code change.

Does it support versioning and changelogs?

Yes, it specifically manages updates to CHANGELOG.md and version strings in pyproject.toml and README.md to ensure all public-facing version info is synchronized.

Can it enforce specific brand or technical terminology?

Absolutely. It uses a project-specific style guide to enforce correct terms (e.g., using 'enforces' instead of 'governs') and prevents the use of banned or deprecated terminology.

Does it verify if the documentation build is broken?

It includes a verification step that runs the documentation engine (like MkDocs) in strict mode to catch broken links, missing pages, or formatting errors before the changes are committed.

Documentation Sync & Enforcement

Name: Documentation Sync & Enforcement
Author: acartag7

byacartag7

•

内容管理

Synchronizes technical documentation with code changes to maintain accuracy and stylistic consistency across software projects.

Documentation Sync & Enforcement is a specialized skill designed to prevent documentation rot by mapping code changes directly to their relevant documentation pages. It enforces strict architectural boundaries and terminology standards—such as distinguishing between core and server features—while ensuring every feature page includes critical sections like 'When to use this' with concrete scenarios. By automating the identification of affected files, updating CHANGELOGs, and verifying builds with MkDocs, it ensures that developers and AI agents alike always have access to a truthful, up-to-date knowledge base.

主要功能

01Mandatory structural verification for documentation pages, including 'When to use this' sections

0210 GitHub stars

03Automated diff mapping to identify affected documentation based on source file changes

04Automated updates for repository-level files like README.md, CHANGELOG.md, and CLAUDE.md

05Strict terminology enforcement to maintain architectural consistency and project vocabulary

06Integrated build verification using MkDocs with strict error checking for broken links

使用场景

01Updating API references and how-to guides immediately after modifying library source code

02Automating the maintenance of project changelogs and version history during the PR process

03Enforcing consistent terminology across a project to ensure 'contracts' aren't mislabeled as 'policies'

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add acartag7/edictum update-docs

For use in Claude.ai and ChatGPT

Download Skill