Skip to content

docs(platform): add Program (OWASP SAMM) page#551

Open
eduardoconviso wants to merge 2 commits into
mainfrom
add-samm
Open

docs(platform): add Program (OWASP SAMM) page#551
eduardoconviso wants to merge 2 commits into
mainfrom
add-samm

Conversation

@eduardoconviso

Copy link
Copy Markdown
Contributor

Summary

New documentation page for the Program module backed by OWASP SAMM v2, covering the features delivered in:

  • Backend: convisoappsec/platform-backend#12694
  • Frontend: convisoappsec/platform-frontend#2569

Adds docs/platform/program-samm.md and registers it under Platform Features → Platform User Guide in sidebars.js (between Threat Modeling and User Management).

Sections covered

  • Overview + OWASP SAMM primer (5 BFs, 15 practices, Stream A/B, levels 0–3)
  • Program Charter (scope, current/target maturity, risk appetite slider 0–100 → Low/Moderate/High/Critical, review cycle, reference assessment)
  • Program Assets (associate/remove)
  • SAMM Assessments — manual + Excel/CSV import
  • Dual-radar (BF 5-axis + Practice 15-axis) and Stream A/B scoring table
  • Initiatives (per-practice, Stream A enforcement, project association)
  • Roadmap (gap, priority badges Critical/High/Medium/Low, initiative mapping)
  • PTT (Percent to Target) + PTD (Progress to Date) explanation
  • Program Report (PDF, EN/PT)
  • Typical workflow + related areas

Missing pieces — screenshots to add

Doc references image paths but the files are not yet committed. Please drop the captures below into static/img/platform/ (light mode, ~1400px wide PNG, real assessment data so radars are non-trivial):

Filename Capture
program-overview.png Program workspace landing — tabs visible (Charter / Assets / Assessments / Initiatives / Roadmap / Report)
program-charter.png Charter form filled — scope, current/target maturity badges, review cycle
program-risk-appetite.png Risk appetite slider with zone indicators + label
program-assets.png Assets tab with rows + Associate Asset dialog open
program-import-samm.png ImportSammDialog with file picker / sample selected
program-assessment-panel.png SammAssessmentPanel — BF 5-axis radar + Practice 15-axis radar + Stream A/B bars table
program-assessment-answers.png SammAssessmentViewPage with per-question answers
program-initiatives.png InitiativesPanel with PracticeInitiativeCard groups + AssociateProjectDialog open
program-roadmap.png RoadmapPanel with priority badges + initiative mapping
program-report-dialog.png ProgramReportDialog with EN/PT language toggle

Test plan

  • yarn start — page renders under Platform Features → Platform User Guide → Program (SAMM)
  • Internal links resolve (Asset Management, Projects, Requirements, Posture, AppSec Manager Guide)
  • After screenshots are added, all ![]() references load
  • No build warnings about broken image paths once screenshots land

🤖 Generated with Claude Code

eduardoconviso and others added 2 commits May 8, 2026 17:51
Documents the new Program module backed by SAMM v2: charter, assets,
assessments (manual + spreadsheet import), dual-radar visualization,
initiatives, roadmap with PTT/PTD, and PDF report generation.

Covers backend PR convisoappsec/platform-backend#12694 and frontend PR
convisoappsec/platform-frontend#2569.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
… detail

Reframe overview around program lifecycle and dynamic risk reduction, promote
typical workflow with outcome-oriented steps, document assessment auto-save and
practice/domain/stream comparisons, clarify automated roadmap generation, and
position the PDF as a complete executive report.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants