Skip to content
Back to skills

Synchronize Documentation

ASecurity

Synchronize existing documentation with an observed code/configuration/API change while preserving each document's purpose and authority. Use after implementation changes can make documentation stale, incomplete, or internally inconsistent.

  • 67 stars
  • 0 votes
  • 0 copies
  • 0 views
  • Added September 29, 2026
documentationgoapidocumentation

Works with

  • api

Security analysis

A100/100

Pro scans all 2 files and shows the line behind each finding

Scanned September 29, 2026

npx -y skills add Jamie-BitFlight/claude_skills --skill synchronize-documentation --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Synchronize Documentation?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Synchronize Documentation
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/jamie-bitflight-synchronize-documentation/badge)](https://www.skillsdirectory.com/skills/jamie-bitflight-synchronize-documentation)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: synchronize-documentation
description: Synchronize existing documentation with an observed code/configuration/API change while preserving each document's purpose and authority. Use after implementation changes can make documentation stale, incomplete, or internally inconsistent.
---
# Synchronize Documentation

Update only documentation whose truth or required coverage changed.

1. Establish the exact implementation delta and externally/user/maintainer-visible consequences.
2. Discover documentation by semantic relationship to the changed contracts, names, paths, configuration, APIs, and workflows. Do not sweep every document without a reason it could be affected.
3. For each candidate document, determine its purpose, audience, authority, and source-of-truth relationship before editing.
4. Compare its material claims with the current implementation/contract. Skip unaffected documents explicitly.
5. Update the narrowest authoritative location. Remove stale claims rather than preserving history inline unless the document's purpose is historical.
6. When several documents duplicate one meaning, consolidate toward the authoritative source and keep navigation pointers where needed.
7. Preserve examples when they are useful executable/user guidance; update or test them rather than banning code examples categorically.
8. Re-read edited documents, validate links/references and repository-required checks, and report changed and examined-but-unchanged surfaces.

Do not modify source behavior as part of documentation synchronization. Do not assume implementation outranks a normative specification; escalate an authority conflict instead of rewriting the specification to match code.

Files in this skill

  • SKILL-GOALS.md310 B
  • SKILL.md1.7 KB

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…