update-how-it-works

Community

Keep feature docs aligned with code.

Authoralexzhang1030
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: update-how-it-works
Download link: https://github.com/alexzhang1030/platform-demo/archive/main.zip#update-how-it-works

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 537,000+ vetted skills library on demand.