Edison Jwa
bba6273af7
- Move ASPICE docs to chanoraapp/docs submodule at docs/ - Move development docs to dev-docs/ (superpowers, offline-knowledge, impl-mapping) - Add AGENTS.md with project conventions for AI agents - Add impl-mapping.md (SAD component → source file mapping) - Archive completed plans to dev-docs/superpowers/plans/_archived/ - Remove AGENTS.md from .gitignore (now tracked)
80 lines
3.4 KiB
Markdown
80 lines
3.4 KiB
Markdown
# Finish DV Document Tree Implementation Plan
|
|
|
|
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
|
|
|
**Goal:** Fill the README-advertised document tree with baseline candidate documents so DV reviewers can navigate all required gates.
|
|
|
|
**Architecture:** Keep canonical large baselines at current root paths and add README-path stubs or summaries where needed. Governance, release, security, privacy, legal, UI/UX, i18n, and references each get explicit baseline documents that state current evidence and open gates honestly.
|
|
|
|
**Tech Stack:** Markdown documentation aligned to SysRS, SysDes, SRS, SAD, SDD, verification, release, and implementation status.
|
|
|
|
---
|
|
|
|
### Task 1: Add Requirements Path Wrappers
|
|
|
|
**Files:**
|
|
- Create: `docs/requirements/sysrs.md`
|
|
- Create: `docs/requirements/srs.md`
|
|
|
|
- [x] **Step 1: Create README entry records that point to canonical root documents and summarize DV review anchors**
|
|
|
|
These wrappers preserve README paths without duplicating the canonical baselines.
|
|
|
|
### Task 2: Add Governance Baselines
|
|
|
|
**Files:**
|
|
- Create: `docs/governance/document-index.md`
|
|
- Create: `docs/governance/document-naming-convention.md`
|
|
- Create: `docs/governance/baseline-approval-record.md`
|
|
- Create: `docs/governance/baseline-candidate-validation-report.md`
|
|
- Create: `docs/governance/document-review-report.md`
|
|
- Create: `docs/governance/product-decision-register.md`
|
|
- Create: `docs/governance/decision-impact-assessment.md`
|
|
- Create: `docs/governance/git-commit-message-convention.md`
|
|
- Create: `docs/governance/repo-format-validation-report.md`
|
|
- Create: `docs/governance/path-migration-map.md`
|
|
|
|
- [x] **Step 1: Write governance records**
|
|
|
|
Each record summarizes status for DV, identifies owner expectations, and avoids claiming final release approval.
|
|
|
|
### Task 3: Add Remaining Release, Security, UI/UX, I18n, Reference Docs
|
|
|
|
**Files:**
|
|
- Create: `docs/release/platform-release-policy.md`
|
|
- Create: `docs/security/threat-model.md`
|
|
- Create: `docs/security/secure-storage-audit-report.md`
|
|
- Create: `docs/security/diagnostic-redaction-audit-report.md`
|
|
- Create: `docs/ui-ux/material3-guideline.md`
|
|
- Create: `docs/ui-ux/material3-design-tokens.md`
|
|
- Create: `docs/ui-ux/material3-component-catalog.md`
|
|
- Create: `docs/ui-ux/adaptive-layout-platform-guide.md`
|
|
- Create: `docs/i18n/localization-architecture.md`
|
|
- Create: `docs/references/external-references.md`
|
|
- Create: `docs/references/aspice-swe2-swe3-integration-note.md`
|
|
|
|
- [x] **Step 1: Write remaining baseline docs**
|
|
|
|
Use concise DV-ready records that reference current implementation and open gaps.
|
|
|
|
### Task 4: Verify Complete Tree
|
|
|
|
**Files:**
|
|
- Inspect all created documents.
|
|
|
|
- [x] **Step 1: Check README paths exist**
|
|
|
|
Run a shell `test -f` command over every README-advertised path.
|
|
|
|
- [x] **Step 2: Sentinel-language scan**
|
|
|
|
Run the sentinel-language scan over `docs/requirements`, `docs/architecture`, `docs/verification`, `docs/release`, `docs/security`, `docs/privacy`, `docs/legal`, `docs/ui-ux`, `docs/i18n`, `docs/governance`, and `docs/references`; expect no matches.
|
|
|
|
---
|
|
|
|
## Self-Review
|
|
|
|
- Spec coverage: fills all README-advertised document paths except already existing files.
|
|
- Placeholder scan: plan contains no incomplete document instructions.
|
|
- Type consistency: file paths match README tree.
|