Instruction file imported from HaniMohamed/ai-doctor-appointment-system (.cursor/rules/auto-doc-sync.mdc). Copyright stays with the author.

Auto Documentation & Progress Tracker

When a task, feature, fix, or refactor is completed:

1. Detect and Update Relevant Markdown Files

   • Automatically search the project for any Markdown files (*.md) that are likely related to:
     • project documentation (docs/, /documentation/, /guide/)
     • planning (plan.md, project_plan.md, roadmap.md)
     • progress tracking (progress.md, report.md, changelog.md, /reports/)
     • overview or onboarding (README.md, overview.md)
   • Detect these files automatically based on their names and directory context — no manual file listing required.

2. Update Documentation Intelligently

   • Append a new summarized entry describing what was done, why, and its impact.
   • Use the following structured format:

     ## [Date - Auto Update]
     **Task:** <brief description of what was completed>  
     **Details:** <summary of changes, features, or fixes>  
     **Impact:** <effect on system, users, or next steps>  
     

   • Keep chronological order (latest updates at the top).
   • Match and preserve the existing file’s style and formatting.

3. Cross-Link Related Files

   • If a README or plan references the updated module, reflect the change (e.g., update feature status, version, or completion date).
   • Update “Next Steps” or “TODO” sections automatically if present.

4. Progress Summary

   • Maintain or create a summary section in progress.md or similar files that shows:
     • Total completed tasks this week
     • Tasks currently in progress
     • Pending or next priorities (derived from plan files)

5. Never Remove Existing Information

   • Only append or modify relevant sections cleanly.
   • Do not delete or overwrite manually written content.

6. Tone & Consistency

   • Write in a professional, technical tone.
   • Maintain consistent Markdown formatting, headings, and spacing.

The purpose of this rule is to keep all project plans, reports, and documentation automatically synchronized with completed work, ensuring real-time project traceability without requiring explicit file declarations.