sync-docs
Sync Docs Skill
Update docs/features/ after major code changes.
When to Use
- After completing a feature or fix
- When documentation is mentioned as outdated
- After significant refactoring
- When user asks to "update docs"
Prerequisites
- You have just completed a code change
- You know which files were modified
Process
1. Identify Changed Components
Focus on:
src/main/(backend logic)src/renderer/(UI components)src/shared/(types, constants)src/features/(feature modules)
2. List Existing Docs
ls docs/features/
head -20 docs/features/*.md
3. Determine Action
For each changed component:
- UPDATE: Feature already has documentation
- CREATE: New feature, needs new doc
- SKIP: Minor change, already covered
4. Documentation Template
# Feature Name
## Overview
One paragraph explaining what this feature does.
## Architecture
- **Service/File:** `src/main/path/to/file.ts`
- **Dependencies:** List key dependencies
## Key Components
### Component 1
Explanation...
### Component 2
Explanation...
## Data Flow (optional)
```mermaid
flowchart LR
A --> B --> C
Configuration (if applicable)
| Setting | Type | Default | Description |
|---|---|---|---|
| ... | ... | ... | ... |
Hotfixes / Changelog (optional)
Hotfix YYYY-MM-DD: Brief Title
- Problem: What was broken
- Solution: How it was fixed
### 5. Write Updates
- **UPDATE**: Use `view_file` → `replace_file_content`
- **CREATE**: Use `write_to_file` with template
### 6. Verify Links
Ensure file paths in docs are correct (use backticks).
### 7. Summary
Report what was done:
- Updated: `docs/features/foo.md` (added XYZ section)
- Created: `docs/features/bar.md` (new feature doc)
More from jstarfilms/vibecode-protocol-suite
google-trends
Automated Google Trends research via Node.js CLI. Search YouTube, Web, Images, News for rising/breakout queries. Use for Phase 1 Strategy research or any topic validation.
121youtube-pipeline
Complete YouTube video production pipeline from ideation to distribution. Covers Strategy (Phase 1), Packaging (Phase 2), Scripting (Phase 3), Shorts (Phase 3.5), Production (Phase 4), and Repurposing (Phase 5).
84ui-ux-pro-max
Comprehensive design guide for web and mobile applications. Contains 50+ styles, 97 color palettes, 57 font pairings, 99 UX guidelines, and 25 chart types. Use when the user requests UI/UX work (design, build, create, implement, review, fix, improve).
36security-audit
Perform a meticulous deep code audit covering Security, Logic, Completeness, and Quality. Includes vibe-coding-specific guardrails for supply chain attacks, auth, rate limiting, and RLS.
33nextjs-standards
Comprehensive coding standards, verification protocols, and templates for Next.js App Router projects. Auto-loads on Next.js detection.
33stitch
|
30