update-docs

Synchronize soma-work documentation with code changes before commits.

Updated Jul 29, 2026
One-click install
npx skills add https://github.com/2lab-ai/soma-work --skill update-docs-2lab-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/2lab-ai/soma-work/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/2lab-ai/soma-work --skill update-docs-2lab-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill ensures that the soma-work documentation remains up-to-date with code changes, maintaining consistency between the codebase and its documentation.

Core Features & Use Cases

  • Documentation Synchronization: Automatically updates documentation before every commit or PR that changes code, structure, commands, workflows, personas, skills, config, or deployment.
  • Explicit Request Support: Triggers on explicit requests like "update docs", "docs sync", or "문서 업데이트".
  • File Checks: Checks README.md, README.ko.md, CLAUDE.md, AGENTS.md, and docs/ for drift against the actual code and fixes it in the same change.
  • Task Completion Indicator: A task is only considered complete when the code, tests, and documentation agree.

Quick Start

Use the update-docs skill to automatically synchronize documentation with your code changes by running it before committing or opening a PR.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I synchronize documentation with code changes automatically before a commit?

To synchronize documentation with code changes, you can trigger an automated process before every commit or PR that checks README files and the docs/ directory for discrepancies and applies fixes in the same change.

What is documentation drift and how do I fix it in my codebase?

Documentation drift occurs when code structure, commands, or workflows change but docs do not. You fix it by checking README.md, README.ko.md, CLAUDE.md, AGENTS.md, and docs/ against the actual code and applying corrections in the same modification.

How does automatic documentation synchronization handle explicit update requests?

Automatic documentation synchronization handles explicit update requests by triggering on specific phrases like "update docs", "docs sync", or "문서 업데이트", checking for drift against the codebase, and applying necessary fixes.

When should I check README files and the docs directory for codebase discrepancies?

You should check README files and the docs directory for codebase discrepancies before every commit or PR that changes code, structure, commands, workflows, personas, skills, config, or deployment to ensure consistency.

Can I use automated documentation synchronization to ensure tests and docs agree with code?

Yes, you can use automated documentation synchronization to ensure tests and docs agree with code. A task is only considered complete when the code, tests, and documentation all align without discrepancies.