Skip to content
Skills Library
Programming · Writing

docs-sync

/docs-sync

Update user or maintainer documentation to match observed software behavior and commands. Use for documentation drift and feature handoffs; avoid speculative or unrelated rewriting.

Repository
boundiff ↗
Licence
MIT
Last repository change
22.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 22.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Update user or maintainer documentation to match observed software behavior and commands. Use for documentation drift and feature handoffs; avoid speculative or unrelated rewriting.

Original author description

Update user or maintainer documentation to match observed software behavior and commands. Use for documentation drift and feature handoffs; avoid speculative or unrelated rewriting.

How it works

  1. Output
Original SKILL.md headings · 16 lines, 158 words
SKILL.md preview
---
name: docs-sync
description: Update user or maintainer documentation to match observed software behavior and commands. Use for documentation drift and feature handoffs; avoid speculative or unrelated rewriting.
---

# Documentation sync

Documentation should describe the software that exists, not the feature as originally imagined.

1. Identify the change, intended reader, relevant entry points, actual config/CLI/API behavior, and current documentation.
2. Verify names, flags, environment variables, examples, version requirements, and error cases against source or a runnable command where practical.
3. Edit only impacted sections. Prefer a working example with realistic input and output over vague adjectives. Preserve the project's voice and established formatting.
4. Ensure installation examples do not overwrite existing files without warning, pipe unreviewed remote scripts into a shell, or require unnecessary privileges.
5. Check local links, code fences, command examples, and the diff. If code and docs disagree, report the mismatch rather than fabricating intended behavior.
6. Distinguish commands **executed** from commands **documented but not run** in the final handoff.

## Output

**Readers affected**, **documentation paths**, **behavioral evidence**, **example checks**, and **known gaps**. Never claim an integration works because its README says so.

Versions

RepositoryScoreLicence
This page · itsofficialadi/boundiff100MIT
kamiazya/whiteboard100Apache-2.0
nearform/lastlight100MIT
laurigates/claude-plugins100MIT
microsoft/apm100MIT
microsoft/apm100MIT
jMerta/codex-skills100MIT
zjunlp/skills100MIT
githubnext/apm100MIT

Database snapshot: 13.11.2026 · package version c08858efe649 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100update-docs
    Update public documentation in docs/public/ when features or tools change. Triggers on "/update-docs", "update docs", "update documentation".
  • 100plan-docs-sync
    Plan-only audit of documentation against actual code behavior. Use when "docs drift", "sync docs with code", "audit documentation", "stale README", "onboarding docs broken", "phantom docs", or "docs out of date". Decisions/ADRs → docs-adr.
  • 100documentation-updater
    Update all project documentation including implementation docs, user guides, API docs, and architecture diagrams. Use when finalizing features to ensure comprehensive documentation.
  • 90nemoclaw-contributor-update-docs
    Update NemoClaw documentation for merged behavior changes. Use for post-merge catch-up or a requested documentation drift audit.
  • 95update-docs-from-commits
    Scan recent git commits for changes that affect user-facing behavior, then draft or update the corresponding documentation pages. Use when docs have fallen behind code changes, after a batch of features lands, or when preparing a release. Trigger keywords - update docs, draft…
  • 100docs-update-from-diff
    Review local code changes with git diff and update the official docs under docs/ to match. Use when the user asks to document current uncommitted work, sync docs with local changes, update docs after a feature or refactor, or when phrases like "git diff", "local changes",…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.