4.0 KiB
4.0 KiB
AGENTS · docs/implplan (Coordination Sprints)
Purpose & Scope
- Working directory:
docs/implplan(sprint planning/coordination docs only). Cross-module edits must be explicitly noted in the relevant sprint’s Decisons & Risks. - Roles supported here: project manager, product manager, implementer (doc maintainer). No code changes are performed in this directory; focus on sprint plans, status, and cross-guild coordination.
Required Reading (treat as read before DOING)
docs/README.mddocs/07_HIGH_LEVEL_ARCHITECTURE.mddocs/modules/platform/architecture-overview.mddocs/implplansprint template rules (see Section “Naming & Structure” below)- Any sprint-specific upstream docs linked from the current sprint file (e.g., crypto audit, replay runbooks, module architecture dossiers referenced in Dependencies/Prereqs sections)
Naming & Structure
- Sprint filename format:
SPRINT_<IMPLID>_<BATCHID>_<SPRINTID>_<topic>.md(see global charter §4.2). Normalize existing files to this format while preserving content and log the rename in Execution Log. - Internal template (required sections): Topic & Scope, Dependencies & Concurrency, Documentation Prerequisites, Delivery Tracker, Wave Coordination (if multi-wave), Wave Detail Snapshots, Interlocks, Upcoming Checkpoints, Action Tracker, Decisions & Risks (incl. risk table), Execution Log.
- Status flow:
TODO → DOING → DONE/BLOCKED. Flip status only when evidence is captured in the sprint doc.
Determinism & Metadata
- Use UTC dates (
YYYY-MM-DD) and include timezone labels for meetings if relevant. - Keep tables ordered deterministically (by task ID or due date). Avoid ad-hoc reshuffling.
- When blocking, state the concrete dependency/document name and expected next signal/date.
Documentation Rules
- For any design/advisory/platform decision surfaced here, update the canonical doc under
docs/**(architecture, ADR, product advisory, etc.) and link it from Decisions & Risks. - Archival: completed tasks should flow to
docs/implplan/archived/tasks.mdas per sprint guidance. - Avoid external URLs unless already present; prefer relative doc links.
Advisory Handling (must do for every new advisory)
- Trigger: any new/updated file in
docs/product-advisories/(current or archived) automatically requires updates below—no chat approval. - Docs: add/update a high-level page in
docs/(vision/key-features/market) and a detailed page in the closest area (docs/reachability/*,docs/market/*,docs/benchmarks/*,docs/modules/<module>/*, etc.). Inline only short snippets; place runnable/long code indocs/benchmarks/**ortests/**(deterministic, offline-friendly) and link. - Sprints: add Delivery Tracker rows in the relevant
SPRINT_*.md, include doc paths, owners, deps; add an Execution Log line and risks/interlocks (schema/feed freeze, transparency caps) when needed. - De-dup: check
docs/product-advisories/archived/; mark “supersedes/extends ` if overlapping to avoid duplicate tasks. - Defaults: hybrid reachability posture (graph DSSE required; edge-bundle optional), deterministic/frozen feeds, offline-ready benches.
- Do not defer: execute steps immediately, then report.
Cross-Module Coordination
- Respect each module’s AGENTS.md when touching module-specific sprint entries; do not change module instructions from here.
- If a required module AGENTS.md is missing/outdated, mark the related task BLOCKED in that module’s sprint and note it in Decisions & Risks here.
Ready-to-Start Checklist (per change)
- Confirm template compliance of the sprint file you’ll edit.
- Verify statuses reflect current reality before adding new actions.
- Add Execution Log line summarizing what changed, with date and role.
Testing / Validation
- No automated tests; validate by: (1) template conformance, (2) table integrity (columns align), (3) links resolve locally.
Contacts & Stand-ups
- Follow sprint-specific checkpoint dates listed in “Upcoming Checkpoints”. Escalations are logged in Decisions & Risks, not via chat.