38 lines
1.4 KiB
Markdown
38 lines
1.4 KiB
Markdown
|
# Documentation Boundaries (Atomizer Standard)
|
||
|
|
|
||
|
|
## Rule
|
||
|
|
- **Project-specific content** belongs in `projects/<project-name>/...`
|
||
|
|
- **Foundational / reusable content** belongs in `docs/...`
|
||
|
|
|
||
|
|
This is a hard rule for all agents.
|
||
|
|
|
||
|
|
## What is project-specific?
|
||
|
|
Store in `projects/...`:
|
||
|
|
- Run logs, experiment outcomes, project decisions
|
||
|
|
- Project playbooks tied to one geometry/client/study
|
||
|
|
- Project troubleshooting notes and sync incidents
|
||
|
|
- Project KPIs, deliverables, and channel-specific context
|
||
|
|
|
||
|
|
## What is foundational?
|
||
|
|
Store in `docs/...`:
|
||
|
|
- Generic workflows used by multiple projects
|
||
|
|
- Platform-level operator guides
|
||
|
|
- Reusable run/checklist templates
|
||
|
|
- Protocols and standards
|
||
|
|
- Cross-project troubleshooting procedures
|
||
|
|
|
||
|
|
## Ownership
|
||
|
|
- **Manager owns documentation quality and structure.**
|
||
|
|
- Drafting can be delegated, but final responsibility remains with Manager.
|
||
|
|
|
||
|
|
## Operating procedure
|
||
|
|
When writing docs:
|
||
|
|
1. Decide: project-specific or foundational.
|
||
|
|
2. Write in the correct location first (no temporary drift).
|
||
|
|
3. If a project doc becomes reusable, promote a generalized version into `docs/...` and keep project examples in the project folder.
|
||
|
|
4. Cross-link both locations when useful.
|
||
|
|
|
||
|
|
## Current Hydrotech application
|
||
|
|
- Hydrotech run/playbook files remain in `projects/hydrotech-beam/...`.
|
||
|
|
- Reusable standards from Hydrotech are promoted into `docs/guides/...` as they stabilize.
|