docs(sow): Statement of Work package + functional flow library - #126
Merged
Conversation
New SoW/ folder with the engagement's SoW documents and per-functionality flow diagrams: - SoW-Atlas-PPM-Product-Build.md / .html — SoW for the full product build - SoW-Atlas-PPM-Remediation.md — SoW for the code-review remediation (Epic #106) - flows/*.mmd — 20 Mermaid flow diagrams, one per functional area (navigation, auth/RBAC, dashboard, demands, portfolio/project, gates, task board, gantt, resources, financials, programs, products/releases, OKRs, delivery, news, connector sync, whiteboard, reports, admin, governance) - images/*.png — static renders (Atlas-themed) of each flow - flows.md — index (live Mermaid + image links); flows-gallery.html — gallery - README.md + .mermaid.json/.puppeteer.json — regeneration config (npx mmdc) Docs only; no application code touched. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F1g44VLAeYdf3FAoXsXRu7
Extend the flow set from system/data flows to three views: - User journeys (flows/user-*.mmd, 8) — persona → goal, step by step: executive review, PMO demand approval, PM create-project wizard, PM task board + Jira sync, PM stage-gate review, team-member update, stakeholder status, manager My Team. - Software-development interaction (flows/dev-*.mmd, 9) — change lifecycle, CI pipeline, API type-contract + drift guard, module-boundary ratchet, test strategy, local dev loop, build & air-gapped deploy, runtime topology, connector extension. 37 flows total (20 system + 8 user + 9 dev), each with a static PNG render. flows.md, flows-gallery.html and README.md regenerated with the three sections. Docs only. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F1g44VLAeYdf3FAoXsXRu7
- Add the two missing role journeys: Platform Admin (administration) and Chief Architect (governance) — user-09, user-10. User journeys now cover all six canonical roles + the architecture identity (10 total). - Add §2.8 "User roles & journeys" to the product-build SoW (Markdown + HTML): a role → header-identity → primary-journey → flow mapping, plus a Deliverables entry for the 39-diagram flow package. Notes the 9 header identities are cosmetic and the 4 Manager identities share the Team Member / My Team journeys. - Regenerate flows.md, flows-gallery.html, README.md (39 flows: 20 system + 10 user + 9 dev). Docs only. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F1g44VLAeYdf3FAoXsXRu7
- Embed all 39 flow images directly in the product-build SoW HTML: the ten per-role journeys inline in §2.8, plus Appendix A (20 system & data flows) and Appendix B (9 development interaction flows). The HTML is now a single self-contained deliverable. - Add §12 Commercials & timeline (pricing model, payment schedule tied to milestones, dates, governing agreement) and §13 Acceptance & sign-off (dual signature blocks) to both the HTML and Markdown. Commercial figures are clearly-marked ‹to be agreed› / ‹TBD› placeholders — scope/milestones/ acceptance are fixed, commercials are for the parties to complete. - Document type is now "for signature (v1.0 draft)". Docs only. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F1g44VLAeYdf3FAoXsXRu7
Add SoW/STATEMENT-OF-WORK.md (+ .html) following the structure of GovernancePortal_Latest/docs/STATEMENT-OF-WORK.md: 17 sections — purpose, background, objectives, scope (12 work packages + out-of-scope), deliverables (D1–D9), delivery phases (P0–P8), milestones & acceptance (M1–M6) + DoD, RACI, assumptions, constraints, environment, security/compliance obligations, change control, risks, commercials, sign-off, references. Grounded in the delivered Atlas system and real docs; parties/dates/commercials left as [brackets] per the house convention. README points to it as the canonical SoW; the product-build and remediation SoWs are the detailed companions. Docs only. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F1g44VLAeYdf3FAoXsXRu7
Add "Appendix A — Functional flows" to SoW/STATEMENT-OF-WORK (both .md and .html): A.1 system & data flows (20), A.2 per-role user journeys (10), A.3 software-development interaction flows (9). The HTML edition embeds all 39 diagrams inline (self-contained); the Markdown references them via relative image links. The canonical SoW is now complete end-to-end (17 sections + embedded flow appendix). Docs only. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F1g44VLAeYdf3FAoXsXRu7
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
SoW/documentation package for the Atlas PPM engagement. Docs-only — no application code touched.STATEMENT-OF-WORK.md/.html) in the Birgma house format: 17 sections (Purpose, Background, Objectives, Scope [12 work packages + out-of-scope], Deliverables D1–D9, Approach/phases P0–P8, Milestones M1–M6 + DoD, RACI, Assumptions, Constraints, Environment, Security/compliance, Change control, Risks, Commercials, Sign-off, References) plus Appendix A — Functional flows (all 39 diagrams embedded). Mirrors the structure ofGovernancePortal_Latest/docs/STATEMENT-OF-WORK.md.SoW-Atlas-PPM-Product-Build.md/sow-atlas-ppm-product-build.html) — detailed build companion; self-contained signable HTML with all flows embedded, Commercials + Sign-off.SoW-Atlas-PPM-Remediation.md) — companion for the Epic Code-review remediation epic — R1–R19 (2026-08-04 review) #106 code-review remediation work.flows/*.mmd) with rendered PNGs (images/*.png): 20 system/data flows, 10 user journeys, 9 software-development interaction flows, indexed inflows.mdandflows-gallery.html.Commercial and party fields are left as clearly-marked
[bracket]/‹TBD›placeholders — the product owner supplies pricing model, dates, supplier legal name and MSA reference to finalise v1.0.Notes
@mermaid-js/mermaid-cliis a doc-render tool invoked vianpx, not added as an app dependency (package.jsonunchanged).🤖 Generated with Claude Code
Generated by Claude Code