agent-tina / docs /documentation-policy.md
KPrashanth's picture
Deploy Agent Tina
5b76cb0 verified
|
Raw
History Blame Contribute Delete
1.3 kB
# Documentation Policy
Agent Tina docs should be updated whenever the project changes in a meaningful way.
## Update Rules
Update `docs/progress.md` when:
- a feature is implemented
- deployment status changes
- a milestone is verified
- a bug is fixed
Update `docs/decisions.md` when:
- a product direction is agreed
- an architecture choice is made
- a deployment/storage/model decision is made
- a tradeoff is intentionally accepted
Update `docs/meeting-workflow.md` when:
- user flow changes
- meeting modes change
- participant behavior changes
- recording guidance changes
Update `docs/architecture.md` when:
- modules are split or added
- storage changes
- APIs or data shapes change
- background jobs or external services are introduced
Update `docs/deployment.md` when:
- Space URL changes
- deployment script changes
- required environment variables change
- runtime requirements change
## Explicit Update Habit
At the end of each implementation session, explicitly mention whether docs were updated.
If no docs were updated, mention why:
```text
Docs not updated because this was a no-op verification change.
```
## Obsidian Usage
Open the project folder `agent_tina` as an Obsidian vault. The docs are in `docs/`, and wiki links are enabled through standard Markdown files.