oe-docs-updates

shami-ah's avatarfrom shami-ah

Keeps OpenEvent-AI “living docs” in sync while coding. Use whenever you fix a bug, discover a new bug, add/modify behavior, or capture a future idea. Updates docs/guides/TEAM_GUIDE.md (bug list + regressions), DEV_CHANGELOG.md (what changed), new_features.md (ideas parked for later), and TO_DO_NEXT_SESS.md (next-session tasks).

⭐0stars🔀1forks📁View on GitHub🕐Updated Jan 8, 2026⬇️1downloads
[Developer Tools]

When & Why to Use This Skill

This Claude skill automates the maintenance of 'living documentation' throughout the software development lifecycle. It ensures that critical project files—including bug trackers, changelogs, feature backlogs, and task lists—stay synchronized in real-time as you code, effectively eliminating documentation debt and improving team coordination.

Use Cases

  • Automated Bug Tracking: Instantly update the TEAM_GUIDE.md with fix statuses and regression test references as soon as a bug is resolved.
  • Continuous Changelog Updates: Maintain an accurate DEV_CHANGELOG.md by automatically logging daily changes, behavior modifications, and verification tests.
  • Session Continuity: Capture pending tasks and priority items into TO_DO_NEXT_SESS.md to ensure a seamless transition and clear starting point for the next coding session.
  • Idea Management: Park 'future ideas' and architectural improvements in new_features.md during debugging sessions to prevent scope creep while preserving valuable insights.
nameoe-docs-updates
descriptionKeeps OpenEvent-AI “living docs” in sync while coding. Use whenever you fix a bug, discover a new bug, add/modify behavior, or capture a future idea. Updates docs/guides/TEAM_GUIDE.md (bug list + regressions), DEV_CHANGELOG.md (what changed), new_features.md (ideas parked for later), and TO_DO_NEXT_SESS.md (next-session tasks).

oe-docs-updates

Workflow (keep entries small + actionable)

  1. If you fixed a bug

    • Update docs/guides/TEAM_GUIDE.md:
      • Find the matching bug entry (search by keywords).
      • Mark status as fixed (or add “Fixed” note).
      • Add a link/reference to the regression test that now covers it (prefer backend/tests/regression/test_team_guide_bugs.py or a specs test).
    • Update DEV_CHANGELOG.md:
      • Add a short entry under today’s date: what changed + which tests verify it.

  2. If you discovered a bug but didn’t fix it

    • Update docs/guides/TEAM_GUIDE.md:
      • Add it under the appropriate “Known Issues / Bugs” section.
      • Include: symptom, likely trigger, suspected module(s), minimal repro hint, and a suggested test file location.
    • Update TO_DO_NEXT_SESS.md:
      • Add a single-line task with priority and where to start (file path + test to write/run).

  3. If you added a feature or changed UX/behavior

    • Update DEV_CHANGELOG.md:
      • Add: new behavior + migration/compat note (if any) + tests.
    • If it’s an idea that you are intentionally not implementing now:
      • Write it to new_features.md instead (see below).

  4. If you found a “future idea” while debugging

    • Add it to new_features.md:
      • Keep it as a small ticket: context → current pain → proposed solution → files likely touched → priority.
      • Do not mix in a partial implementation here.

Style rules (important for debugging agents)

  • Prefer searchable keywords in headings and bullets (“billing capture”, “site visit”, “detour”, “HIL”, “smart shortcuts”).
  • Always include one concrete pointer: failing test name, script path, or function/module.
  • Avoid long narratives. Target: ≤10 lines per doc update.