update-docs-and-commit

Updates documentation files (changelog, architecture, project_status) based on git changes, then stages and commits all changes. Use after completing features or fixes.

16 stars

Best use case

update-docs-and-commit is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Updates documentation files (changelog, architecture, project_status) based on git changes, then stages and commits all changes. Use after completing features or fixes.

Teams using update-docs-and-commit should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/update-docs-and-commit/SKILL.md --create-dirs "https://raw.githubusercontent.com/diegosouzapw/awesome-omni-skill/main/skills/documentation/update-docs-and-commit/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/update-docs-and-commit/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How update-docs-and-commit Compares

Feature / Agentupdate-docs-and-commitStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Updates documentation files (changelog, architecture, project_status) based on git changes, then stages and commits all changes. Use after completing features or fixes.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# Update Docs and Commit

Automatically analyzes git changes and updates project documentation to reflect new features, fixes, and architectural changes.

## What This Skill Does

1. **Analyze git changes** - Examine staged/unstaged changes via `git status` and `git diff`
2. **Update changelog** - Add entries for new features and bug fixes to `docs/changelog.md`
3. **Update architecture** - Only modify `docs/architecture.md` if structural changes occurred
4. **Update project status** - Move completed items in `docs/project_status.md`
5. **Create commit** - Stage and commit all documentation changes

## When to Use

Use this skill when:
- You've completed a feature or bug fix
- You want to keep documentation synchronized with code changes
- You need to create a clean commit with updated docs

Invoke by saying:
- "Update docs and commit"
- "/update-docs-and-commit"
- "Document what we just built and commit"

## Execution Steps

### Step 1: Analyze Git Changes

Run these commands to understand what changed:

```bash
git status --short
git diff HEAD --stat
git log -1 --oneline
```

### Step 2: Categorize Changes

Categorize based on:
- **Feature**: New functionality (new files, new routes, new components)
- **Fix**: Bug fixes (modifications to existing files)
- **Refactor**: Code organization without behavior change
- **Architecture**: Structural changes (new directories, schema changes, new integrations)
- **Chore**: Dependencies, configs, tooling

### Step 3: Update docs/changelog.md

Read the current changelog and add entries under `## [Unreleased]`:

```markdown
### Added
- Feature name - brief description

### Fixed
- Bug name - what was fixed

### Changed
- What changed and why
```

Be concise. One line per item.

### Step 4: Update docs/architecture.md (Conditional)

**Only update if:**
- New directories were created
- Database schema changed
- New components/routes added to architecture
- API routes added or changed

**Skip update if:**
- Only bug fixes
- Only styling changes
- Only logic changes within existing structure

If updating, modify the relevant section (component tree, API routes table, etc.)

### Step 5: Update docs/project_status.md

Read current status and:
- Move completed items from "Pending" to "Done"
- Update progress percentages
- Update milestone status if appropriate

### Step 6: Create Commit

Stage and commit all changes:

```bash
git add -A
git commit -m "$(cat <<'EOF'
docs: update documentation for recent changes

- Updated changelog with new features/fixes
- Updated project status with completed items
[- Updated architecture docs (if applicable)]

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
EOF
)"
```

Show the user what was committed with `git show --stat HEAD`.

## Conservative By Design

This skill is intentionally conservative:
- Only updates docs that genuinely need updating
- Doesn't over-document small changes
- Leaves architecture.md alone for non-structural changes
- Creates focused, readable changelog entries

## Example Output

After running, you should see:

```
✓ Analyzed 5 changed files
✓ Updated docs/changelog.md (added 2 features, 1 fix)
✓ Updated docs/project_status.md (marked 3 tasks complete)
✓ docs/architecture.md unchanged (no structural changes)
✓ Created commit: docs: update documentation for recent changes
```

Related Skills

write-docs

16
from diegosouzapw/awesome-omni-skill

Write documentation with real, validated examples. Executes commands through the user to capture actual output. Use for any new documentation or major doc updates.

wiki-docs

16
from diegosouzapw/awesome-omni-skill

Document custom Magento 2 site functionality in the project wiki. Systematically captures custom features, modules, configurations, and business logic for client handover and developer onboarding.

update-docs

16
from diegosouzapw/awesome-omni-skill

Update documentation pages to match source code changes on the current branch

three-tier-docs

16
from diegosouzapw/awesome-omni-skill

Use after code changes. Syncs CLAUDE.md, CONTEXT.md, and docs/ai-context/ automatically.

sync-docs

16
from diegosouzapw/awesome-omni-skill

Strategic documentation sync - review docs before implementation (pull context) OR export learnings after implementation (push to living docs). NOT bidirectional - two separate one-way operations at different phases.

smart-pr-docs

16
from diegosouzapw/awesome-omni-skill

Intelligent PR documentation generator that analyzes code changes, tracks ripple effects across the codebase, updates claude.md files, and creates visual dependency maps. USE WITH codebase-architecture-mapper for elite "System-Aware" context.

review-docs

16
from diegosouzapw/awesome-omni-skill

Review documentation (README.md and CLAUDE.md) for quality, completeness, and consistency. Use when asked to review docs, check documentation, validate README files, or audit CLAUDE.md coverage.

reindex-docs

16
from diegosouzapw/awesome-omni-skill

Re-index all PDF and HTML documents, update index.html, and commit/push changes to the repository

pitchdocs-suite

16
from diegosouzapw/awesome-omni-skill

One-command generation and audit of the full public repository documentation set — README, CHANGELOG, ROADMAP, CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, issue templates, PR template, and discussion templates. Use when setting up a new repo or auditing an existing one.

organize-agent-docs

16
from diegosouzapw/awesome-omni-skill

Organize project agentic documentation into universal (AGENTS.md) and agent-specific files (CLAUDE.md, GEMINI.md, etc.). Use when asked to "organize agent docs", "separate agent instructions", "restructure AGENTS.md", or when a project has agent documentation that mixes universal and tool-specific content.

openclaw-docs-sync

16
from diegosouzapw/awesome-omni-skill

Sync OpenClaw + ClawHub + Skills docs into a local mirror for the QMD memory backend.

moai-docs-unified

16
from diegosouzapw/awesome-omni-skill

Enhanced docs unified with AI-powered features. Enhanced with Context7 MCP for up-to-date documentation.