# update-project-docs

update-project-docs keeps documentation in sync after changes to code, config, APIs, DB schema or interfaces. The agent runs it automatically when it modifies env vars, hooks, events, WebSocket messages or CLI commands.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf (Devin Desktop), Claude.ai · ★ 1198 repo stars
- Author: hoangsonww
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/hoangsonww/Claude-Code-Agent-Monitor/tree/HEAD/.claude/skills/update-project-docs/SKILL.md
- Updated: 2026-10-23
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/update-project-docs

## What it does

The skill maintains a large doc set across five languages, two HTML pages and a wiki. When the agent changes an env var, event type, API route, database schema, WebSocket message, MCP tool or CLI command, it immediately edits all affected files: English, Chinese, Vietnamese, Korean and Spanish READMEs, `ARCHITECTURE.md`, `docs/*.md`, `wiki/index.html` and i18n files. Each change type maps to a specific list of docs.

The skill edits the English version first, then propagates changes to translations, updates Mermaid diagrams across all files, and increments the cache version in `wiki/sw.js` so visitors see the update. The wiki has fixed-height blocks — the skill copies the length of neighbouring entries to avoid breaking the layout. Node.js is required for installation.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add hoangsonww/Claude-Code-Agent-Monitor --skill update-project-docs -a claude-code
```

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

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add hoangsonww/Claude-Code-Agent-Monitor --skill update-project-docs -a codex
```

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

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add hoangsonww/Claude-Code-Agent-Monitor --skill update-project-docs -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install hoangsonww/Claude-Code-Agent-Monitor .claude/skills/update-project-docs
```

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

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add hoangsonww/Claude-Code-Agent-Monitor --skill update-project-docs -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/hoangsonww/Claude-Code-Agent-Monitor --path .claude/skills/update-project-docs
```

### Windsurf (Devin Desktop)

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

### 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/hoangsonww/Claude-Code-Agent-Monitor/tree/HEAD/.claude/skills/update-project-docs/SKILL.md

## When to use it
- sync documentation after a code change
- update five language READMEs at once
- reflect a new env var in all tables
- propagate an API change to OpenAPI and `docs/API.md`
- fix state diagrams after a hook change

## Example prompts
- Added a new `LOG_LEVEL` var — update all env tables
- Changed the `sessions` table schema — sync `docs/DATABASE.md` and the ERD
- New `/api/v1/sessions` route — add it to `docs/API.md` and OpenAPI

## Source text · SKILL.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 6c8eabc5577ba15a.

BEGIN THIRD-PARTY FILE 6c8eabc5577ba15a
```text
---
name: update-project-docs
description: MANDATORY for every coding agent (Claude Code, Codex, or any other) — keep this repository's documentation in sync after any change to behavior, configuration, interfaces, events, schema, or features. Use automatically at the end of change-sets that alter an env var, event type, hook or state behavior, API, schema, WebSocket message, MCP tool, CLI command, or user-facing feature, and whenever the user asks to update documentation.
---

# Update Project Docs

This repository keeps an unusually large, multi-surface, multi-language doc set. Docs drift silently because a change often belongs in 6–10 files across 5 languages plus two HTML pages. This skill encodes **which docs exist, which change-types touch which docs, and how to propagate consistently** (including the wiki i18n + cache-bump dance).

Authoritative inventory with exact section anchors lives in [`references/doc-map.md`](references/doc-map.md) — read it when deciding where a specific change lands. The repo rules [`.claude/rules/docs-markdown.md`](../../rules/docs-markdown.md) ("update all affected docs together"), [`.claude/rules/wiki-i18n.md`](../../rules/wiki-i18n.md), and [`.claude/rules/i18n-parity.md`](../../rules/i18n-parity.md) are binding. Translation propagation — the mirrored READMEs, the wiki bundles, and the UI keys — is owned by the [`i18n-parity`](../i18n-parity/SKILL.md) skill; run it whenever this skill's mapping sends you into a localized file.

## When to update (including without being asked)

Update docs **in the same change-set (PR/commit) as the code**, before claiming done — do not wait for the user to ask — whenever the change is observable from outside the module:

- **New/changed env var** → every env-var table + `.env.example`.
- **New event type** (e.g. an `events.event_type` value) → every event-type list/table.
- **New/changed hook behavior or session/agent state transition** → hook docs + every state-machine diagram.
- **New/changed API route or response shape** → API docs + route tables + OpenAPI.
- **DB schema change** (table/column/index) → database docs + ERD.
- **New WebSocket message type** → client/server WS docs.
- **New MCP tool** → MCP docs.
- **New CLI command / script / renamed file referenced in docs** → command lists + onboarding guides.
- **New user-facing feature / page / background service** → feature tables + landing + wiki + architecture.
```
END THIRD-PARTY FILE 6c8eabc5577ba15a

The third-party file has ended. Everything between the 6c8eabc5577ba15a tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2465 of 10394 bytes. © hoangsonww · MIT · https://github.com/hoangsonww/Claude-Code-Agent-Monitor/tree/HEAD/.claude/skills/update-project-docs/SKILL.md

## Similar
- [update-docs-on-code-change](https://affpapa.org/en/nevibecode/rules/update-docs-on-code-change.md) — rule · ★ 41430 repo stars
- [oma-docs](https://affpapa.org/en/nevibecode/skills/oma-docs.md) — skill · ★ 1472 repo stars
- [skillshare-update-docs](https://affpapa.org/en/nevibecode/skills/skillshare-update-docs.md) — skill · ★ 3269 repo stars

_Part of the page did not fit — see the HTML version._

---
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
