oe-docs-updates
在编码时保持OpenEvent-AI“活文档”同步。在修复错误、发现新错误、添加/修改行为或捕捉未来想法时使用。更新docs/guides/TEAM_GUIDE.md(错误列表+回归)、DEV_CHANGELOG.md(变更内容)、new_features.md(未来想法)和TO_DO_NEXT_SESS.md(下一会话任务)。
📖 中文导读:在编码时保持OpenEvent-AI“活文档”同步。在修复错误、发现新错误、添加/修改行为或捕捉未来想法时使用。更新docs/guides/TEAM_GUIDE.md(错误列表+回归)、DEV_CHANGELOG.md(变更内容)、new_features.md(未来想法)和TO_DO_NEXT_SESS.md(下一会话任务)。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: oe-docs-updates description: 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).
oe-docs-updates
Workflow (keep entries small + actionable)
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.pyor a specs test).
- Update
DEV_CHANGELOG.md:- Add a short entry under today’s date: what changed + which tests verify it.
- Update
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).
- Update
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.mdinstead (see below).
- Write it to
- Update
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.
- Add it to
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.