Skip to content

WIP: docs: add Feature & Component Modelling How-To and Requirements Inspection agent#2965

Open
antonkri wants to merge 2 commits into
mainfrom
ankr_modelling_howto
Open

WIP: docs: add Feature & Component Modelling How-To and Requirements Inspection agent#2965
antonkri wants to merge 2 commits into
mainfrom
ankr_modelling_howto

Conversation

@antonkri

@antonkri antonkri commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

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 from docs/contribute/development/index.rst)

Step-by-step guide covering the reduced metamodel actually in use today:

  • Which sphinx-needs directives to write on the feature side (score repo: 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).
  • The required cross-repo links (belongs_to / fulfils / satisfies / implements).
  • Where each inspection checklist lives and how to set it up, with direct links to the official process_description folder templates (pinned to v1.5.4, the version score consumes via bazel_dep).
  • Step 5 sub-section explains how to invoke the new Requirements Inspection agent.

.github/agents/req-inspection.agent.md + .github/skills/req-inspection-checklist/SKILL.md (new)

  • Agent definition and companion skill.
  • Scaffolds and fills chklst_req_inspection.rst for a single S-CORE feature per invocation.
  • Scope: feature-level feat_req inspections in the score repo. Component-level comp_req inspections in module repos are not yet supported and the agent stops when given a module/component name.
  • Invocation: copilot --allow-all-tools --agent "Requirements Inspection" -p "<feature-name>"

Build

bazel run //:docs_check passes (only the 6 pre-existing non-fatal warnings on lifecycle remain, unrelated to this change).

@antonkri antonkri changed the title docs: add Feature & Component Modelling How-To and Requirements Inspection agent WIP: docs: add Feature & Component Modelling How-To and Requirements Inspection agent Jun 10, 2026
antonkri added 2 commits June 10, 2026 11:01
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.
@antonkri antonkri force-pushed the ankr_modelling_howto branch from 04e45c5 to 7b21e14 Compare June 10, 2026 11:01
@github-actions

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@github-actions

Copy link
Copy Markdown

Thanks for the pull request. This thread has been quiet for 30 days, so we are marking it as stale for now. Please take a quick look and let us know whether it is still up to date, still relevant, needs review, or is ready to merge. Any new activity will remove the stale label automatically. If nothing changes in the next 10 days, we will close it to keep the backlog current.

@github-actions github-actions Bot added the Stale label Jul 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Backlog
Status: No status

Development

Successfully merging this pull request may close these issues.

1 participant