# Chipikaf Vizcraft Documentation Update Policy > Documentation Update Policy - Skill: `tomevault-io/chipikaf-vizcraft-documentation-update-policy` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add tomevault-io/chipikaf-vizcraft-documentation-update-policy` - Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/chipikaf-vizcraft-documentation-update-policy/raw - Safety review: pending (external: skill-scanner PASS, skillspector PASS) - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Docs & Writing - Author: tomevault-io (https://skillmd.com/u/tomevault-io) - Updated: 2026-09-17 - Page: https://skillmd.com/skills/tomevault-io/chipikaf-vizcraft-documentation-update-policy --- # Documentation Update Policy ## Non-negotiable rule - Every **user-facing change** must update documentation in the same PR. User-facing includes: - public APIs (builder methods, types, exports) - behavior/defaults (layout, anchors, runtime patching conflict rules) - animations/overlays (spec fields, playback semantics, registries) - CSS hooks (classes, `--viz-*` variables) - examples and demo behavior ## What to update - `README.md` (high-level overview + quick start) - `packages/core/README.md` (keep aligned with root README when relevant) - `packages/docs/docs/**` (comprehensive documentation) ## What good doc updates look like - Add a short “why” and a clear mental model. - Provide copy/paste-able examples. - Call out edge cases, back-compat, and migration notes. - Link to type anchors in `types.mdx` when you introduce new concepts. ## Definition of done - Code compiles/tests. - Docs explain the new behavior. - Examples reflect the final API and run without guesswork. --- > Source: [ChipiKaf/vizcraft](https://github.com/ChipiKaf/vizcraft) — distributed by [TomeVault](https://tomevault.io).