Add example stakeholder table to EN Section 1 (Introduction and Goals) - #237
Open
Sofeso wants to merge 1 commit into
Open
Add example stakeholder table to EN Section 1 (Introduction and Goals)#237Sofeso wants to merge 1 commit into
Sofeso wants to merge 1 commit into
Conversation
The Stakeholders subsection only had a two-row placeholder table (<Role-1>, <Contact-1>, <Expectation-1>), giving no sense of what a filled-in table looks like or which roles typically apply. Added a worked example under the existing help block (visible in the 'with help' template variant only, same convention as .Motivation/ .Form), listing recurring stakeholder roles (Product Owner, End Users, Architects, Dev Team, Ops/SRE, Security, Compliance/Legal, Sponsor) cross-referenced to the arc42 sections their expectations map to. Closes arc42#198
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
2 participants
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.
Closes #198.
Problem
The Stakeholders subsection's only table is the bare placeholder (
<Role-1>,<Contact-1>,<Expectation-1>, one more blank row). Someone filling out the template for the first time has no sense of what a reasonable, filled-in version looks like, or which roles typically show up on a real project.Change
Added a worked example table inside the existing
arc42helpblock, right after the existing.Formdescription — same convention already used for.Motivation/.Formelsewhere in this file, so it only appears in the "with help" template variant and doesn't touch the blank fillable table real projects start from.The example lists roles that recur across most software projects (Product Owner, End Users, Architects, Dev Team, Ops/SRE, Security/InfoSec, Compliance/Legal, Sponsor/Management), each cross-referenced to the arc42 section their expectations map to (e.g. Ops needs Section 7 deployment view + Section 8 cross-cutting concepts). I checked docs.arc42.org's own Section 1 guidance first — it doesn't currently include an example table either, so this isn't duplicating existing content.
Verification
Built both output formats locally via
./gradlew -Planguages=EN:arc42-template-EN.html— table renders correctly, "Example" appears as a proper block title matching the existing Motivation/Form styling (confirmed no raw AsciiDoc syntax leaked into output).arc42-template-EN.pdf— builds cleanly, 944 KB output.validateImagesENtask passed (unaffected by this change, but confirms the build overall is healthy against my branch).Disclosure
I used AI assistance (Claude) to research this issue, draft the stakeholder list/wording, and verify the build. I reviewed and take responsibility for the content. Happy to adjust roles/wording/scope if you'd prefer a different set or format.