Skip to main content

Documentation Completeness Review in-progress

This page is the portal quality gate. It answers a direct question:

Can each audience use the portal without reading raw repo docs first?

Current Readiness By Audience

AudienceCurrent postureStrongest pagesStill thin
Product teamusable but needs more screenshots and journey proofProduct Team Handoff, Current State And Roadmap, Use AI Cloud, Screenshot Flow Coveragefresh screenshots beyond MFA
Architecture / ARBstrong enough for reviewOverall Platform Architecture, System Overview, Code Structure And Layer Model, Service Design Matrix, Detailed Design Indexdeeper service-specific diagrams as code changes
CISO / Securityusable, evidence-awareSecurity & Production Readiness, Current Controls, Evidence Readiness Modelclearer claim readiness per environment and less inherited CISO ceremony language
Developersusable for orientationDeveloper Implementation Map, Developer APIs, Code Structure And Layer Model, Service Design Matrixfeature-specific implementation packets as new work starts
App / SDK developersstrong for concept, improving for build pathBuild on AI Cloud, App SDK Proof, Add a New Appscreenshot-backed app launch/connect guide and more example-code walkthrough
Token Factory / shared-platform buildersgood first-passToken Factory Builder Path, Shared Platform Consumer Track, Product Onboarding, Shared Servicesimplementation packet once Token Factory moves from design to code
IAMgood model coverageIAM Capabilities, Resource Model and Naming, MFA Walkthroughservice-account UX and recovery/admin operation screenshots
Infragood environment/deployment startInfra and Environments, Production Deployment Model, Demo and Staging Setup, Node Lifecyclelive staging/demo evidence once environments are created
Operationsgood operating model startOperators, Release Operations, CI/CD Delivery System, Service Version Readbackimplementation of version/readback API/UX
End userspartially usableEnd User Guide, Screenshot Flow Coverage, MFA Walkthrough, Launch and Operatefull fresh screenshot coverage for launch, connect, billing, storage, tenant admin, and troubleshooting

Completion Criteria

The portal should not be called complete until these are true:

  1. Each top persona has one clear entry path and one “what this proves” page.
  2. User-facing workflows have screenshot-backed guides for the main happy, blocked, recovery, and cleanup paths.
  3. Architecture pages include a top-down overview plus detailed design packets with diagrams that are enough to start implementation.
  4. Developer pages connect contracts, generated artifacts, state models, package ownership, local validation, and CI gates.
  5. Security pages distinguish implemented controls, environment posture, evidence, deferred claims, and accepted residual risk.
  6. Operations pages show deploy, rollback, evidence, monitor, and version readback procedures.
  7. Canonical source links render as readable portal pages where possible and raw artifacts remain available for audit.

Active Backlog

Backlog itemOwnerPriorityNotes
screenshot-backed user guide for launch/connect/storage/billing/tenant-admindocs + product qualityP0coverage model exists at Screenshot Flow Coverage; fresh screenshots still needed
service-level ER/sequence/state diagramsarchitectureP0cross-service matrix exists at Service Design Matrix; add deeper diagrams as service code changes
environment version/readback pageopsP0target model exists at Service Version Readback; API/UX implementation still needed
Token Factory builder patharchitecture + productP1first builder page exists at Token Factory Builder Path
demo/staging setup walkthroughinfra + opsP1first setup model exists at Demo and Staging Setup
prose reduction passproduct + UXP1move explanation into help/info affordances and guides
AI Cloud naming sweepdocsP1keep GPUaaS only where it names the GPU product/resource domain

Review Method

For each portal section, use this test:

Could a competent person in this audience do the next real task from this page?

If the answer is no, add a concrete backlog row here or fix the page directly.