# update-docs

Updates project documentation based on uncommitted git changes or the latest commit. Keeps README files, docs/, and JSDoc comments synchronized with your codebase.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 1300 installs · ★ 1787
- Author: NeoLabHQ
- License: GPL-3.0 · policy=link-only · description only; the file stays with the author
- Source: https://github.com/NeoLabHQ/context-engineering-kit/tree/HEAD/skills/update-docs/SKILL.md
- Updated: 2026-08-26
- HTML: https://affpapa.org/en/nevibecode/skills/update-docs

## What it does

The skill inspects local edits using `git status -u` or inspects the latest commit via `git show`. It begins by reading the root `README.md` and project manifests such as `package.json` or `pyproject.toml` to capture formatting conventions and API structures.

Complexity determines the execution strategy. For minor changes across one or two files, the primary agent writes updates directly. When three or more files change or public APIs undergo significant modifications, the skill switches to a multi-agent pipeline. Haiku subagents parse diffs across documentation areas in parallel, while Sonnet or Opus subagents draft the updated text. Working inside an initialized git repository is strictly required, because the analysis pipeline relies directly on git diffs.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add NeoLabHQ/context-engineering-kit --skill update-docs -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/update-docs/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/update-docs/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add NeoLabHQ/context-engineering-kit --skill update-docs -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/update-docs/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add NeoLabHQ/context-engineering-kit --skill update-docs -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/update-docs/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install NeoLabHQ/context-engineering-kit update-docs
```

2. **Manually: put the files in place**
- File: `.github/skills/update-docs/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add NeoLabHQ/context-engineering-kit --skill update-docs -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/NeoLabHQ/context-engineering-kit --path skills/update-docs
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/update-docs/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add NeoLabHQ/context-engineering-kit --skill update-docs -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/NeoLabHQ/context-engineering-kit/tree/HEAD/skills/update-docs/SKILL.md

## When to use it
- synchronize project `README.md` and `docs/` files with recent code edits
- refresh public API signatures and JSDoc comments after refactoring
- analyze git diffs to generate prioritized documentation task lists
- delegate documentation updates across parallel specialized subagents

## Example prompts
- Update project documentation for all uncommitted changes
- Inspect the latest commit and refresh README.md
- Focus on public API changes and update docs/

## Similar
- [update-docs-on-code-change](https://affpapa.org/en/nevibecode/rules/update-docs-on-code-change.md) — rule · ★ 40418
- [docs-updater](https://affpapa.org/en/nevibecode/skills/docs-updater.md) — skill · 3500 installs
- [code-documentation](https://affpapa.org/en/nevibecode/skills/moizibnyousaf-code-documentation.md) — skill · 563 installs
- [api-docs](https://affpapa.org/en/nevibecode/skills/api-docs.md) — skill · 891 installs
- [jsdoc-typescript-docs](https://affpapa.org/en/nevibecode/skills/jsdoc-typescript-docs.md) — skill · 547 installs
- [docs-guard](https://affpapa.org/en/nevibecode/skills/docs-guard.md) — skill · 4000 installs

From the same set: [neolabhq/context-engineering-kit](https://affpapa.org/en/nevibecode/by/neolabhq/context-engineering-kit.md) — 64 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md