home/productivity/vibe-syncdocs

Vibe SyncDocs

GPTClaudeDeepSeek··425 copies·updated 2026-07-14
vibe-syncdocs.prompt
---
description: Review recent code changes and update docs/features accordingly
---
# Workflow: Documentation Sync

> Direct Takomi workflow prompt for syncing feature documentation after implementation work.

Update `docs/features/` after major code changes so the docs stay aligned with the implementation.

---

## Steps

### 1. Identify Changed Components
Determine the main files or subsystems changed in the recent work.
Use the user request, recent git diff, or known modified files.
Focus on the components that materially affect behavior, architecture, configuration, or usage.

### 2. List Existing Feature Docs
Inspect `docs/features/` and understand current coverage.
Do not create duplicate docs when an update is the correct action.

### 3. Read Existing Docs
Read existing docs that appear related so you can determine scope, naming, and current coverage.

### 4. Determine the Documentation Action
For each changed component, decide whether to:
- **update** an existing feature doc
- **create** a new feature doc
- **skip** if already fully covered and no meaningful doc change is needed

### 5. Documentation Standards
Each feature doc should generally include:
- overview
- architecture
- key components or modules
- optional data flow
- configuration if applicable
- usage notes if relevant
- changelog / hotfix notes when useful

Suggested structure:

when to use it

Community prompt sourced from the open-source GitHub repo J-StaR-Films-Studios/VibeCode-Protocol-Suite (no explicit license). A "Vibe SyncDocs" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.

tags

productivitycommunitydeveloper

source

J-StaR-Films-Studios/VibeCode-Protocol-Suite · no explicit license