Update Docs

Documentation impact analysis and update workflow

hongmaple0820 3b7b97b 959 B Updated

File contents

Update Docs

Use this skill when behavior, commands, configuration, public API, governance rules, or release workflow changes.

Workflow

  1. Identify entry docs that users rely on first: README, AGENTS, getting started, workflow docs, and command help.
  2. Update only docs whose contract changed.
  3. Keep examples executable and aligned with current command names.
  4. Mention verification limits when a workflow is not fully exercised.
  5. Run doc-related tests or governance drift checks when available.

Evidence

  • Updated doc paths and why they changed.
  • Commands or tests used to validate generated docs and templates.
  • Explicit note for docs intentionally left unchanged.

Anti-Patterns

  • No stale command examples.
  • No doc-only promise for a rule that should be enforced by script or config.
  • No broad README rewrite for a narrow behavior change.

hongmaple0820/scale-engine/tree/main/.scale/skills/update-docs commit 3b7b97b4ba

Frequently asked questions

npx skillmds@latest add hongmaple0820/update-docs