返回 Skill 列表
extension
分类: 开发与工程无需 API Key

doc-update

在代码更改后更新文档,以保持文档与代码实际情况同步。请在实现完成后使用。涵盖功能文档、工作流文档和索引文件。

person作者: jakexiaohubgithub

Doc Update

Keep documentation evergreen by updating immediately after code changes.

When to Use

  • After completing any code change
  • After fixing a bug or adding a feature
  • Before running /handoff
  • When /drift-check identifies stale docs

Hierarchy

Updates flow from specific to general:

  1. Feature Docsdocs/features/{feature}.md
  2. Workflow Docsdocs/workflows/{role}-workflows.md
  3. Index Files → FEATURE_INDEX.md, WORKFLOW_INDEX.md
  4. Architecture Docsdocs/engine/*.md (if patterns changed)

Quick Reference

| Files Changed | Update | |---------------|--------| | app/actions/*.ts | Feature doc → Server Actions | | app/(routes)/** | Feature doc → User Surfaces | | components/** | Feature doc + Component Index | | supabase/migrations/* | Feature doc → Data Model + prod SQL | | lib/ai/** | AI context docs + feature docs |

Feature Doc Sections to Update

  • User Surfaces: Routes, UI elements
  • Data Model: Tables, columns, relationships
  • Server Actions: Action name, purpose, tables, auth
  • Permissions: RLS policies, admin client usage
  • Invariants: Add newly discovered rules
  • Testing Checklist: Update verification steps

Output

## Doc Update Complete

### Updated
| Doc | Sections |
|-----|----------|
| [feature].md | User Surfaces, Data Model |

### Production SQL
- Provided: [Yes/No]

### Verification
Run `/drift-check` to confirm no remaining drift.

Related