43 lines
2.6 KiB
Markdown
43 lines
2.6 KiB
Markdown
DISCUSSION – Areas, Structure, Ownership
|
||
|
||
Context
|
||
- This repo hosts generic, foundational practices reusable across projects.
|
||
- Areas: COMMON (shared practices), CTO (shared technical standards), COO (business ops), CCO (deferred; placeholder only).
|
||
|
||
Decisions Confirmed
|
||
- Area directories are uppercase: COMMON, CTO, COO, CCO.
|
||
- Shared practices and base guidance live under COMMON.
|
||
- CCO is deferred for now; placeholder directory only.
|
||
|
||
Open Questions to Confirm
|
||
- Naming conventions within areas
|
||
- File naming: keep kebab-case (e.g., [COMMON/git-workflow.md](COMMON/git-workflow.md)) or use TitleCase?
|
||
- Per-area `README.md` vs. `INDEX.md` expectations.
|
||
- Scope boundaries
|
||
- COMMON: include Git workflow, CI/bootstrap parity, templates (PR/issue), documentation style guide, ADR pattern, security/privacy baselines?
|
||
- CTO: preferred tech stacks, language/runtime versions, container base image policy, local dev environment patterns (devcontainers/Make), testing strategy, quality bars?
|
||
- COO: operating rhythm (cadences, ceremonies), roles/RACI, OKR/KPI templates, onboarding, procurement/vendor-lite guidance, documentation templates?
|
||
- CCO: when in scope, include customer journey templates, support/SLA baselines, enablement playbooks, feedback loops? Any overlap rules with COO/CTO?
|
||
- Consumers and audience
|
||
- Internal only or some content public-facing? Any confidentiality/compliance constraints (esp. COO/CCO)?
|
||
- Reuse strategy
|
||
- Copy into new repos vs. reference centrally? Provide “adoption guides” per area? Offer minimal vs. advanced profiles?
|
||
- Ownership & change control
|
||
- CODEOWNERS per area? Who approves updates across COMMON/CTO/COO?
|
||
- Labels and PR templates per area; contribution guidelines?
|
||
- Document shape and standards
|
||
- Prescriptive checklists vs. narrative guidance; include “10-minute quickstart” per area?
|
||
- Standardize front‑matter, headers, and ADR structure?
|
||
- Cross‑cutting policies
|
||
- Where to maintain shared policies (security, privacy, accessibility) — under COMMON?
|
||
- CI for docs
|
||
- Keep current markdown/yaml linters repo‑wide; add link checker/spellcheck?
|
||
- Migration of existing docs
|
||
- Which existing files beyond Git workflow and CI bootstrap should move under COMMON now vs. later (e.g., proposals, questions, [RESUME.md](RESUME.md), [TODO.md](TODO.md))?
|
||
|
||
Proposed Next Steps (pending answers)
|
||
- Seed per‑area README with scope, audiences, adoption guidance.
|
||
- Create COMMON/templates/ for reusable checklists, PR/issue templates, ADRs.
|
||
- Map/move additional shared docs into COMMON and update references.
|
||
- Define CODEOWNERS and contribution norms per area.
|