docs: add mailbox-first collaboration model
This commit is contained in:
54
README.md
54
README.md
@@ -1,6 +1,7 @@
|
||||
# Minion Template
|
||||
|
||||
This repository is a source template for running coordinated AI assistant roles (minions) with durable markdown-based collaboration in git.
|
||||
This repository is a source template for running coordinated AI assistant roles
|
||||
(minions) with durable markdown-based collaboration in git.
|
||||
|
||||
It provides a baseline operating model for:
|
||||
|
||||
@@ -14,43 +15,64 @@ It provides a baseline operating model for:
|
||||
|
||||
This README is template-scaffolding guidance.
|
||||
|
||||
When this template is used to create a downstream project, this file should not be copied forward as-is. Downstream repositories should replace it with a project-specific README to avoid role/process confusion.
|
||||
When this template is used to create a downstream project, this file should not
|
||||
be copied forward as-is. Downstream repositories should replace it with a
|
||||
project-specific README to avoid role/process confusion.
|
||||
|
||||
## Repository Purpose
|
||||
|
||||
This template exists to make multi-agent coordination explicit, durable, and reviewable by combining:
|
||||
This template exists to make multi-agent coordination explicit, durable, and
|
||||
reviewable by combining:
|
||||
|
||||
- shared memory and guardrails
|
||||
- role-specific context files
|
||||
- formal planning artifacts
|
||||
- chat-thread decision history
|
||||
- mailbox packet history
|
||||
- PM-owned continuity summaries
|
||||
- explicit handoff and evidence discipline
|
||||
|
||||
## Basic Onboarding
|
||||
|
||||
Use this sequence immediately after creating a downstream project from this template:
|
||||
Use this sequence immediately after creating a downstream project from this
|
||||
template:
|
||||
|
||||
1. Establish a filtered vendored template snapshot and perform the first controlled export using [docs/downstream-onboarding-playbook.md](docs/downstream-onboarding-playbook.md).
|
||||
2. Complete [docs/operator-onboarding-checklist.md](docs/operator-onboarding-checklist.md) with the Operator.
|
||||
1. Establish a filtered vendored template snapshot and perform the first
|
||||
controlled export using
|
||||
[docs/downstream-onboarding-playbook.md](docs/downstream-onboarding-playbook.md).
|
||||
2. Complete [docs/operator-onboarding-checklist.md](docs/operator-onboarding-checklist.md)
|
||||
with the Operator.
|
||||
3. Finalize project-specific sections in [MEMORY.md](MEMORY.md).
|
||||
4. Open the first milestone plan from [minions/plans](minions/plans).
|
||||
5. Create and use the current daily thread in [minions/chat](minions/chat).
|
||||
6. Initialize and maintain ROADMAP.md, TODO.md, and CHANGELOG.md.
|
||||
7. Use [docs/downstream-upgrade-playbook.md](docs/downstream-upgrade-playbook.md) for later template updates.
|
||||
5. Bootstrap mailbox coordination using
|
||||
[docs/project/mailbox-collaboration-model.md](docs/project/mailbox-collaboration-model.md)
|
||||
and [minions/mail](minions/mail); use `minions/mail/` for new actionable
|
||||
packets and `minions/chat/` for PM summaries.
|
||||
6. Initialize and maintain `ROADMAP.md`, `TODO.md`, and `CHANGELOG.md`.
|
||||
7. Use [docs/downstream-upgrade-playbook.md](docs/downstream-upgrade-playbook.md)
|
||||
for later template updates.
|
||||
|
||||
## Core Files
|
||||
|
||||
- [INIT.md](INIT.md): startup framing and handoff expectations
|
||||
- [MEMORY.md](MEMORY.md): shared truth and baseline guardrails
|
||||
- [minion-version.md](minion-version.md): template/downstream versioning format
|
||||
- [docs/collaboration-playbook.md](docs/collaboration-playbook.md): high-level operating pattern
|
||||
- [docs/downstream-onboarding-playbook.md](docs/downstream-onboarding-playbook.md): PM-owned initial downstream export workflow
|
||||
- [docs/downstream-upgrade-playbook.md](docs/downstream-upgrade-playbook.md): PM-owned downstream upgrade workflow
|
||||
- [docs/export-manifest.md](docs/export-manifest.md): per-file export and merge strategy
|
||||
- [docs/collaboration-playbook.md](docs/collaboration-playbook.md): high-level
|
||||
operating pattern
|
||||
- [docs/project/mailbox-collaboration-model.md](docs/project/mailbox-collaboration-model.md):
|
||||
mailbox-first communication model
|
||||
- [docs/downstream-onboarding-playbook.md](docs/downstream-onboarding-playbook.md):
|
||||
PM-owned initial downstream export workflow
|
||||
- [docs/downstream-upgrade-playbook.md](docs/downstream-upgrade-playbook.md):
|
||||
PM-owned downstream upgrade workflow
|
||||
- [docs/export-manifest.md](docs/export-manifest.md): per-file export and merge
|
||||
strategy
|
||||
- [minions/roles](minions/roles): role charters
|
||||
- [minions/plans](minions/plans): formal planning artifacts
|
||||
- [minions/chat](minions/chat): durable conversation threads
|
||||
- [minions/mail](minions/mail): mailbox packet coordination
|
||||
- [minions/chat](minions/chat): PM-owned continuity summaries
|
||||
|
||||
## Guardrail Reminder
|
||||
|
||||
Minions may keep role context in their role files under [minions/roles](minions/roles), but no minion may alter existing base guardrails/rules without explicit Operator approval.
|
||||
Minions may keep role context in their role files under
|
||||
[minions/roles](minions/roles), but no minion may alter existing base
|
||||
guardrails/rules without explicit Operator approval.
|
||||
|
||||
Reference in New Issue
Block a user