WIP: docs: add Feature & Component Modelling How-To and Requirements Inspection agent#2965
Open
antonkri wants to merge 2 commits into
Open
WIP: docs: add Feature & Component Modelling How-To and Requirements Inspection agent#2965antonkri wants to merge 2 commits into
antonkri wants to merge 2 commits into
Conversation
Step-by-step guide covering the reduced metamodel actually in use today: which sphinx-needs directives to write on the feature side (score repo) vs. the realisation side (module repos), the required cross-repo links (belongs_to / fulfils / satisfies / implements), and how to wire up the inspection checklists.
Adds the Requirements Inspection agent (.github/agents/req-inspection.agent.md) and its companion skill (.github/skills/req-inspection-checklist/SKILL.md). The agent scaffolds and fills chklst_req_inspection.rst for a single S-CORE feature per invocation. Scope is limited to feature-level feat_req inspections in the score repo; component-level comp_req inspections in module repos are not yet supported.
04e45c5 to
7b21e14
Compare
|
The created documentation from the pull request is available at: docu-html |
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.
WIP
For now, just for sharing with other colleagues, no merging planned yet
Summary
Adds a practical, step-by-step Feature & Component Modelling How-To plus the Requirements Inspection agent that automates the first inspection checklist.
Contents
docs/contribute/development/modelling_howto.rst(new, linked fromdocs/contribute/development/index.rst)Step-by-step guide covering the reduced metamodel actually in use today:
stkh_req,feat_req,feat,logic_arc_int(_op)) vs. on the realisation side (module repos:feat_arc_sta/_dyn,mod/mod_view_sta,comp/comp_arc_sta,comp_req).belongs_to/fulfils/satisfies/implements).process_descriptionfolder templates (pinned tov1.5.4, the version score consumes viabazel_dep)..github/agents/req-inspection.agent.md+.github/skills/req-inspection-checklist/SKILL.md(new)chklst_req_inspection.rstfor a single S-CORE feature per invocation.feat_reqinspections in the score repo. Component-levelcomp_reqinspections in module repos are not yet supported and the agent stops when given a module/component name.copilot --allow-all-tools --agent "Requirements Inspection" -p "<feature-name>"Build
bazel run //:docs_checkpasses (only the 6 pre-existing non-fatal warnings onlifecycleremain, unrelated to this change).