Repository navigation
Workflow and issue guidance uses direct, evergreen language - #270
Open
Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Open
Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Conversation
8 tasks done
There was a problem hiding this comment.
🟢 Approved
No active review issues remain for the documentation changes clarifying workflow stages and issue guidance.
No open issues 🎉
What changed in this PR
This documentation-only PR clarifies the canonical workflow and issue guidance with direct, evergreen en-US prose. It distinguishes integration from operation while preserving planning responsibilities and review gates.
Changes:
- Replaces metaphors and indirect wording with explicit work steps.
- Clarifies stage boundaries, issue planning, and readiness and completion criteria.
- Removes temporary Feature migration wording; no executable code, tests, configuration, or dependencies change.
| File | Description |
|---|---|
src/docs/Ways-of-Working/Workflow.md |
Clarifies the continuing process and separates merge from operation. |
src/docs/Ways-of-Working/Workflow-Stages/Security-Review.md |
Simplifies defensive-review purpose and reporting instructions. |
src/docs/Ways-of-Working/Workflow-Stages/Review.md |
Clarifies independent assessment, evidence checks, and approval conditions. |
src/docs/Ways-of-Working/Workflow-Stages/Maintain-Guidance.md |
Makes authoring, routing, and validation instructions explicit. |
src/docs/Ways-of-Working/Workflow-Stages/Implement.md |
Clarifies delivery responsibilities and alignment-pass scope. |
src/docs/Ways-of-Working/Workflow-Stages/Define.md |
Simplifies capture, refinement, and planning instructions. |
src/docs/Ways-of-Working/Issues/Types/PBI.md |
Describes readiness as coordination of delivery. |
src/docs/Ways-of-Working/Issues/Types/Hierarchy.md |
Removes temporary Feature migration language. |
src/docs/Ways-of-Working/Issues/Types/Epic.md |
Describes the Initiative strategy boundary directly. |
src/docs/Ways-of-Working/Issues/Process/Planning.md |
Clarifies independent child work and outcome-based scope. |
src/docs/Ways-of-Working/Issues/Process/Lifecycle.md |
Clarifies unblocked execution and operational feedback. |
src/docs/Ways-of-Working/Goal-Setting.md |
Simplifies strategy, objectives, and delivery relationships. |
src/docs/Ways-of-Working/Definition-of-Ready-and-Done.md |
States readiness, required-check, and completion gates directly. |
Review effort: Balanced
Marius Storhaug (MariusStorhaug)
dismissed
Copilot’s stale review
via
November 4, 2026 12:46
8527fa1
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
November 4, 2026 14:43
3 tasks
This branch has not been deployed
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.
Workflow and issue guidance describes capture, planning, delivery, review, and operation in direct en-US prose. Contributors, maintainers, and agents can distinguish strategy, aggregate coordination, delivery work, and completion evidence without metaphor or temporary migration status.
No reader action is required. This documentation-only change does not add policy, implementation, enforcement, tooling, or dependencies.
Changed: Workflow and issue guidance states the continuing process directly
The pages use concrete process descriptions and direct work steps. Epic and PBI guidance retains consumer expectations and native coordination; Task and Bug guidance retains technical decisions and test-first delivery plans. Merge remains distinct from publication, deployment, operation, and template completion.
Exact recognized prompts, commands, examples, native types and relationships, normative force, headings, anchors, and complete readiness and evidence gates retain their meaning. The obsolete Feature migration sentence is replaced with the enduring classification rule, using the closed migration and current native-type configuration as evidence.
Technical details
Immutable scope and delivery record
1b0d4893c8fefabe604d04393068a8ff6f848082.8527fa103940caa38e715daeaa5b678d9e31df5a.The criteria come from the fixed baseline's Documentation Model, Natural Language, Technical Writing Guide, Markdown, Documentation, and applicable standard, orchestration-playbook, and guide templates. Existing artifact roles and sections remain; this is not a template restructure.
The official STEMG overview and FAQ were read. The verified local Issue 9 source, MD5
9c720341c350ed77943b2c73d01c716f, was consulted for terminology, approved meanings, active voice, short sentences, conditional instructions, and procedural/descriptive distinctions. The PDF and extract remain local and are not republished.Full read and disposition evidence
Paths below are relative to
src\docs\Ways-of-Working.Workflow.mdWorkflow-Stages\Define.mdWorkflow-Stages\Implement.mdWorkflow-Stages\Review.mdWorkflow-Stages\Security-Review.mdWorkflow-Stages\Maintain-Guidance.mdWorkflow-Stages\index.mdIssues\index.mdIssues\Process\Format.mdIssues\Process\Lifecycle.mdIssues\Process\Planning.mdIssues\Process\Relationships.mdIssues\Process\index.mdIssues\Types\Epic.mdIssues\Types\PBI.mdIssues\Types\Hierarchy.mdIssues\Types\Task.mdIssues\Types\Bug.mdIssues\Types\index.mdGoal-Setting.mdDefinition-of-Ready-and-Done.mdConcrete before/after acceptance evidence
The repeatable prose checks establish 15 desired results absent at the fixed baseline and all 15 present at the final head. The four observed Workflow defect strings are absent. Manual review compares the complete changed passages and their technical meaning, not only these strings.
This is the heartbeat of the MSX ecosystem.andThe loop never stops.The workflow connects issue capture, planning, delivery, review, and operation.Continuous activities and their signals are described directly.so it exists for the world to see and "remember"The issue gives contributors and agents a persistent record to refine.After merge, the system is live.The delivery team operates the system and responds to signals.Pain before solution - push back on implementation-framed requests.Identify the problem before you select a solution.The following sentence challenges requests without a stated problem.plan from scratchin the stage boundaryImplement does not build an Epic or PBI, start without a delivery plan, or supply independent review.tests that exercise behaviourtests that exercise behaviorlabelledlabeled, with the exact native title and label syntax retainedbloated agent fileduplicate process instructions, replaced with a thin documentation pointerA concrete organization-level bet to move a Key ResultAn organization-level effort to improve a Key ResultReady gates starting, not scopeandfigured out on the flyReadiness determines when work starts, not its scope.to be picked up independentlyfor independent work, retaining local Why and acceptance criteriaFeed production signals and learning back into the issue model.Record operational signals and findings in the issue model.organization-level bet under an OKRAn Initiative is an organization-level effort under an OKR.A PBI is ready for delivery when:A PBI is ready to coordinate delivery when:Feature remains temporary live metadata while ... retires existing usage.Feature describes a kind of work, not a planning altitude.Its prohibition as a hierarchy node remains.The exact before-text and immutable source links are also retained in #257. #90 is closed, and the organization API lists Task, Bug, Epic, and PBI, with no Feature type. Only the obsolete migration link is removed; every other link destination remains unchanged.
Final meaning review removed an unintended per-push frequency from an intermediate draft. The final work step is
run relevant local checks. Do not push known failures to CI.It preserves the existing obligation without adding policy.Validation at the final head
markdownlint-cli20.24.0, without installation.Test-DocumentationLink.ps1; 130 files scanned; all resolve.Test-CrossRepositoryLink.ps1; 7 links across 134 files; all resolve. An anonymous retry hit the shared 60/hour quota; the authenticated retry passed. Authentication was process-local; no credential or persistent access was created.zensical build --clean; no issues, 2.29 seconds. Five rendered acceptance cases pass, including both regenerated descriptions.git diff --checkpasses; exactly 13 owned Markdown files change; working tree clean.8527fa103940caa38e715daeaa5b678d9e31df5a; no inline comments. The bounded three-minute helper elapsed before the review arrived; the completed GitHub receipt confirms the clean final round.Reproducible site sequence: archive
8527fa103940caa38e715daeaa5b678d9e31df5ainto a session-only validation directory, run the archived.github\scripts\Update-DocumentationIndex.ps1, then run& $PinnedPython -B -m zensical build --cleanfrom the archivedsrcdirectory. The private interpreter's package version is verified as 0.0.59. Source configuration stays unchanged; output remains in session artifacts. The global 0.0.50 installation and the shared validation environment are not modified.Standards and framework alignment
The shared writing set below is the fixed-baseline Natural Language, Technical Writing Guide, Markdown, Documentation, and Documentation Model guidance, plus the official sources cited above. Applicable standard/playbook/guide roles remain in their existing sections.
Workflow.mdWorkflow-Stages\Define.mdWorkflow-Stages\Implement.mdWorkflow-Stages\Review.mdWorkflow-Stages\Security-Review.mdWorkflow-Stages\Maintain-Guidance.mdIssues\Process\Lifecycle.mdIssues\Process\Planning.mdIssues\Types\Epic.mdIssues\Types\PBI.mdIssues\Types\Hierarchy.mdGoal-Setting.mdDefinition-of-Ready-and-Done.mdAccepted differences and exclusions
Direct imperative work steps remain imperative. Exact recognized prompts, native issue types and relationships, commands, Gherkin and Mermaid examples, technical nouns, normative contracts, quotations, and the Now/Next/Later planning model keep their purpose. The retained quotation
You build it, you run it.is not rewritten as authored process prose. Time is the subject of Current OKRs and planning horizons; these are not delivery-status narratives.No generated INDEX marker table is hand-edited or committed. Existing CI generation, also exercised in the isolated build, updates the shared Ways-of-Working index from the two changed descriptions. No heading, anchor, navigation key, requirement reference, or cross-owned link repair is needed.
The app-managed branch name follows the explicit session naming instruction; the one-Task/one-branch/one-PR boundary remains. The campaign's explicit draft-only instruction stops this delivery before the general workflow's ready/auto-merge handoff. The source pages retain that general policy.
These checks support the manual review. Counts, scans, and automated approval do not establish full STE conformance or prove policy implementation/enforcement. No integration-template change applies to this process-prose-only result. The site route does not invoke Release Management, so no release decision block or
release:*label applies.Scoped issue convergence and remaining questions
The finished-change sweep searched open issue titles for
workflow,issue, and the campaign prefix. It found this delivery Task, #96, #154, and the other independently owned campaign parts. The complete bodies of #96 and #154 were read. Neither converges: the former proposes a different issue-planning policy, and the latter requests a new entry-side premise-verification gate. This prose change implements neither. Both stay open; no additional closing keyword is added.Three pre-existing policy questions remain recorded for separate resolution, not silently reconciled:
Repo-local linter config wins where it disagrees with a published standard.sentence remains. The Coding Standards index says configuration derives from standards, while Markdown says configuration is authoritative on disagreement. Precedence interpretation remains unresolved as directed by the coordinator.No implementation or validation blocker remains for the focused prose deliverable. These policy questions and the separate requests above remain outside it. The delivery Task stays open because this PR is not merged.
Delivery boundary: This PR stays DRAFT. It is not merged; auto-merge is off; Agent merge is disabled with
merge_pr: false. Human review and integration are not performed by this delivery.Related references