Architecture Use Case Diagram Prompts¶
This file collects six end-to-end prompts for producing use-case diagrams in Mermaid per FCC audience segment. Diagrams live under docs/architecture/use-case-diagrams/ with one file per audience: beginner.md, educator.md, scientist.md, and professional.md. Each prompt pins personas, R.I.S.C.E.A.R. slots, and deliverable shapes.
Table of Contents¶
- Beginner Use Cases
- Educator Classroom Use Cases
- Scientist Research Use Cases
- Professional Production Use Cases
- Cross-Audience Overlap Review
- New Audience Segment: Auditor
1. Beginner Use Cases¶
When to use. Refreshing the beginner landing page with concrete first-run scenarios.
Personas/subsystems invoked. cw, dal. R.I.S.C.E.A.R. slot: Input + Style.
You are the Content Writer (cw). Data Analyst Lead (dal) reviews.
Open docs/architecture/use-case-diagrams/beginner.md.
TASK: Produce an improved Mermaid `flowchart` use-case diagram for a
first-time FCC user. Actors: Beginner, FCC CLI. Use cases:
- Install FCC and run `fcc --version`.
- Run a first scenario from src/fcc/data/scenarios/.
- Read a single model card under docs/model-cards/.
- Inspect one persona via `fcc persona show dal`.
CONSTRAINTS:
- Keep to 4 to 6 use cases so it stays digestible.
- Use stadium shapes for actors and rounded rect for use cases.
- No advanced concepts (no federation, no compliance).
Style: Teach, do not intimidate. Avoid jargon.
Deliverable: Mermaid block plus a 2-sentence caption the docs site can
render above it.
Expected output notes. 4 to 6 nodes; no advanced FCC concepts; caption under 60 words.
2. Educator Classroom Use Cases¶
When to use. Updating the educator page to reflect the 24-chapter guidebook and 10 labs.
Personas/subsystems invoked. cw, tr. R.I.S.C.E.A.R. slot: Expected Output.
You are the Content Writer (cw). Technical Reviewer (tr) reviews.
Open docs/architecture/use-case-diagrams/educator.md.
TASK: Produce a use-case diagram for a classroom educator. Actors:
Instructor, Student, FCC Scaffolding CLI. Use cases should include:
- Scaffold a lab exercise from docs/guidebook/.
- Assign one of the 10 labs.
- Grade using assessment rubrics (src/fcc/data/docs/assessment_rubrics).
- Screenshare one of the 27 Streamlit apps (pick one).
- Replay a recorded collaboration session via SessionRecorder.
CONSTRAINTS:
- Each use case must name the real file/app/module it touches.
- Include one <<extends>> relationship (grading extends assignment).
Deliverable: Mermaid block plus a table matching each of the 10 labs to
the persona category it exercises.
Expected output notes. 5 use cases, one <
3. Scientist Research Use Cases¶
When to use. Updating the research persona's entry point on the docs site.
Personas/subsystems invoked. dal, ra. R.I.S.C.E.A.R. slot: Input + Responsibilities.
You are the Data Analyst Lead (dal). Risk Analyst (ra) reviews.
Open docs/architecture/use-case-diagrams/scientist.md.
TASK: Produce a use-case diagram for an open-science researcher. Actors:
Scientist, FCC RAG Pipeline, Knowledge Graph. Use cases:
- Register a hypothesis in a scenario JSON.
- Run a deterministic simulation across 3 seeds.
- Export results to an RDF/SKOS knowledge graph.
- Generate a CLEAR+ benchmark report.
- Cite results in a publication via the Quarto pipeline
(publications/_quarto.yml).
CONSTRAINTS:
- Reference the 7 CLEAR+ dimensions in one use-case label.
- Reproducibility must be explicit (seeded deterministic mode).
Deliverable: Mermaid block plus a 3-row table mapping each use case to
the src/fcc/ module that implements it.
Expected output notes. 5 use cases; CLEAR+ 7 dimensions named; seed reproducibility explicit.
4. Professional Production Use Cases¶
When to use. Driving the docs page for an enterprise professional considering FCC.
Personas/subsystems invoked. sre, ra. R.I.S.C.E.A.R. slot: Constraints.
You are the Site Reliability Engineer (sre). Risk Analyst (ra) reviews.
Open docs/architecture/use-case-diagrams/professional.md.
TASK: Produce a use-case diagram for a professional production adopter.
Actors: Ops Engineer, Compliance Officer, FCC Stack. Use cases:
- Deploy via docker-compose.prod.yml.
- Run K8s smoke with the charts/fcc/ Helm chart.
- Trigger a compliance audit via `fcc compliance-audit`.
- Export model cards and datasheets for auditor handoff.
- Hook an EventSubscriberPlugin into a production SIEM.
CONSTRAINTS:
- Do not invent new CLI commands.
- Include one <<includes>> relationship (audit includes evidence export).
Deliverable: Mermaid block plus a 4-line Role Adoption Checklist that
maps each use case to an SLA.
Expected output notes. 5 use cases; one <
5. Cross-Audience Overlap Review¶
When to use. Ensuring the four audience diagrams share a consistent vocabulary.
Personas/subsystems invoked. tr, cw. R.I.S.C.E.A.R. slot: Constraints + Role Adoption Checklist.
You are the Technical Reviewer (tr). Content Writer (cw) reviews.
Read all four files under docs/architecture/use-case-diagrams/:
beginner.md, educator.md, scientist.md, professional.md.
TASK: Produce a Markdown report with:
1. A Mermaid flowchart showing overlap: use cases common to >=2 audiences.
2. A table listing vocabulary inconsistencies (e.g., "scenario" vs
"experiment", "lab" vs "exercise").
3. A 5-item Role Adoption Checklist for the doc maintainer to unify
language.
CONSTRAINTS:
- Do not propose merging audience files.
- Do not invent new audiences.
Deliverable: Markdown body with one overlap flowchart, a 5-row table,
and a 5-item checklist.
Expected output notes. Overlap flowchart with at least 3 shared nodes; 5 vocabulary issues; checklist actionable.
6. New Audience Segment: Auditor¶
When to use. A new auditor persona profile is being proposed; no diagram exists yet.
Personas/subsystems invoked. ra, cw. R.I.S.C.E.A.R. slot: Expected Output + Role Skills.
You are the Risk Analyst (ra). Content Writer (cw) reviews.
No file exists yet at docs/architecture/use-case-diagrams/auditor.md.
Author one.
TASK: Produce a use-case diagram for an external EU AI Act auditor.
Actors: Auditor, FCC Compliance Pipeline, Evidence Graph.
Use cases (4 to 6):
- Request a full risk classification via AIActClassifier.
- Browse findings in the compliance_audit dashboard.
- Export evidence graph as RDF for archival.
- Request a NIST AI RMF crosswalk report (29 subcategories).
- Sign off via the Collaboration approval gate.
CONSTRAINTS:
- Match counts: 256+ EU AI Act requirements, 29 NIST subcategories.
- Must include one <<extends>> and one <<includes>>.
Deliverable: a new Markdown file with front matter (title, description,
audience=Professional), a Mermaid block, and a 3-item Role Skills list
for the auditor persona stub.
Expected output notes. New file with valid front matter, Mermaid block with both stereotypes, real regulatory counts.