Back to list
RustyLindquist

doc-update

by RustyLindquist

An AI-Enhanced Online Academy for HR

0🍴 0📅 Jan 25, 2026

SKILL.md


name: doc-update description: Updates documentation after code changes to keep docs in sync with code reality. Use AFTER implementation is complete. Covers feature docs, workflow docs, and index files. allowed-tools: Read, Write, Glob, Grep

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 ChangedUpdate
app/actions/*.tsFeature 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.

Score

Total Score

50/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

Reviews

💬

Reviews coming soon