update-how-it-works

Update how-it-works documentation for changed feature behavior and data flow.

Updated Mar 17, 2026
One-click install
npx skills add https://github.com/alexzhang1030/platform-demo --skill update-how-it-works
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-how-it-works
Source: https://github.com/alexzhang1030/platform-demo/tree/main/.agents/skills/update-how-it-works
Command: npx skills add https://github.com/alexzhang1030/platform-demo --skill update-how-it-works

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill keeps implementation documentation accurate when a feature changes, so engineers do not have to reverse-engineer behavior from stale notes.

Core Features & Use Cases

  • Doc Synchronization: Updates how-it-works pages when architecture, data flow, rendering logic, or interaction behavior changes.
  • Feature-Specific Coverage: Maps code changes to the right document instead of rewriting unrelated documentation.
  • Compact Engineering Guidance: Explains the current system, key files, main flow, and practical constraints in a format another developer can quickly use.
  • Use Case: After changing a component in apps/web/src/components/pattern-studio, refresh the corresponding how-it-works entry so the repository stays readable and accurate.

Quick Start

Ask to update the relevant how-it-works documentation for the feature you changed and describe the current implementation clearly in the matching file.

Frequently Asked Questions about update-how-it-works

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update feature documentation when implementation changes alter architecture or data flow?

To update feature documentation, map the implementation changes to the correct how-it-works file, preserving one document per feature. This ensures concise, feature-scoped documentation for current code paths stays aligned with the codebase.

What is the best way to keep how-it-works docs aligned with code after modifying components?

The best way to keep how-it-works docs aligned is refreshing the corresponding documentation entry immediately after changing a component. This explains the current system, key files, and main flow so engineers avoid reverse-engineering behavior from stale notes.

When do I need to refresh feature-scoped technical writing for engineering workflows?

You need to refresh feature-scoped technical writing when a feature changes its behavior, architecture, rendering, or interaction logic. This keeps the repository documentation index in sync and provides compact engineering guidance for current code paths.

Does this documentation synchronization method support mapping changes to specific files?

Yes, this documentation synchronization method maps code changes to the right document instead of rewriting unrelated documentation. It maps implementation changes to the correct how-it-works files, preserving one document per feature.

Can I use this approach to update documentation for components in pattern-studio?

Yes, you can use this approach to update documentation for components in pattern-studio and related OpenSpec-backed features. It applies to engineering workflows needing concise documentation for current code paths in apps/web/src/components/pattern-studio.