generated from coulomb/repo-seed
tegwick
1c0c0efc56
Adopt CoulombSocial/HelixForge/MarkiTect documentation structure: - research/260608-yawex-prior-art/ — yawex exploration and sources - demand/ — inbound NetKingdom integration requirements - spec/ — PRD, TSD, UseCaseCatalog, ArchitectureBlueprint scaffolds - docs/ — stakeholder documentation and repository-layout guide - wiki/, issues/, history/ — scaffolded directories Add SCOPE.md and AGENTS.md. Update workplan paths and README.
58 lines
1.6 KiB
Markdown
58 lines
1.6 KiB
Markdown
# Repository documentation layout
|
||
|
||
This repository follows the CoulombSocial / HelixForge / MarkiTect documentation
|
||
layout. It is a **recommendation** for efficient information retrieval, not a
|
||
strict law.
|
||
|
||
## Operating model
|
||
|
||
- `INTENT.md` captures aspiration and boundaries.
|
||
- `SCOPE.md` captures a top-level view of what we achieve.
|
||
- Work closes the gap from SCOPE to INTENT while learning and refining both.
|
||
|
||
## Directories
|
||
|
||
### `research/`
|
||
|
||
Exploration results in the problem and solution space. Use a `yymmdd-` prefix
|
||
on markdown files or subdirectories when multiple files or sources are involved.
|
||
|
||
### `demand/`
|
||
|
||
Inbound feature requests, requirements, and suggestions not yet reviewed into
|
||
`spec/` or `workplans/`. Raw material — needs scrutiny before implementation.
|
||
|
||
### `spec/`
|
||
|
||
Implementation guardrails. Typical files:
|
||
|
||
- `ProductRequirementsDocument.md`
|
||
- `TechnicalSpecificationDocument.md`
|
||
- `UseCaseCatalog.md`
|
||
- `ArchitectureBlueprint.md`
|
||
|
||
Background: InfoTechPrimers on coulomb.social.
|
||
|
||
### `workplans/`
|
||
|
||
State Hub–registered workplans with implementation tasks. Finished or canceled
|
||
workplans move to `history/` with a `yymmdd-` archive prefix.
|
||
|
||
### `docs/`
|
||
|
||
Stakeholder documentation (this directory).
|
||
|
||
### `wiki/`
|
||
|
||
Interconnected collective knowledge without a single perspective. Powerful when
|
||
connected to a wiki UI for creators, users, and investors.
|
||
|
||
### `issues/`
|
||
|
||
Optional mirror of relevant open tickets from customer support, dev-sec-ops, or
|
||
other ticket systems.
|
||
|
||
### `history/`
|
||
|
||
Archived material no longer needed for daily work. Use `yymmdd-` prefixes.
|
||
Consult only for research or diagnostics. |