Skills

Update Project Docs

MANDATORY for every coding agent (Claude Code, Codex, or any other), keep this...

Install

npx skills add hoangsonww/Claude-Code-Agent-Monitor --skill update-project-docs -g -a claude-code -y
Category
AI and agents
Updated
5d ago
License
MIT
Context cost
Mediumabout 2,457 tokens
Runs scripts
Yes, review before use

What it does

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, read it when deciding where a specific change lands. The repo rules .claude/rules/docs-markdown.md ("update all affected docs together"), .claude/rules/wiki-i18n.md, and .claude/rules/i18n-parity.md are binding. Translation propagation, the mirrored READMEs, the wiki bundles, and the UI keys, is owned by the i18n-parity 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.
Read the whole SKILL.md on GitHub

More in AI and agents