SimReady Add Feature
Purpose
Use this skill to add a brand-new SimReady feature under nv_core/sr_specs/docs/features/. A feature is a versioned runtime/use-case contract made from exact requirement IDs and optional feature dependencies.
Do not use this skill for a new version of an existing feature. Use simready-foundation-update-feature for that.
Prerequisites
Before editing, read:
AGENTS.md
nv_core/sr_specs/docs/guides/guides.md
nv_core/sr_specs/docs/guides/features/features.md
nv_core/sr_specs/docs/guides/naming_conventions.md
nv_core/sr_specs/docs/features/features.md
- existing neighboring feature markdown and JSON files for the same domain
If the feature will be added to a profile, also read nv_core/sr_specs/docs/guides/profiles/profiles.md and the target profile markdown/TOML entries.
Inputs
Collect or infer:
| Input |
Requirement |
feature_number |
Numeric ID such as 025. If absent, inspect existing feature IDs and propose the next appropriate number. |
feature_id |
Exact ID such as FET025_BASE_NEUTRAL; must match the variant pattern used by existing JSON manifests. |
version |
Initial semantic version, usually 0.1.0 unless the user states otherwise. |
display_name |
Human-readable feature name. |
runtime_promise |
Concrete asset behavior the feature guarantees. |
requirements |
Existing requirement IDs or new requirement docs/validators needed by the feature. |
dependencies |
Exact feature IDs and versions this feature depends on. |
profile_targets |
Optional profiles and versions that should adopt the feature. |
validation_strategy |
Automated validator, runtime test, manual test, or documented gap. |
conform_skill_plan |
New conform skill name, existing conform skill to update, or documented reason no conform skill can safely repair the feature. |
Instructions
Use this checklist when changing the repository:
- Inspect existing feature numbers, IDs, filenames, and variant suffixes. Avoid reusing an ID or inventing a new suffix when an existing suffix matches.
- Define the runtime promise in asset terms before choosing requirements.
- Prefer existing requirements and validators. Add new requirement docs or validators only when the feature needs a new testable rule.
- Create the JSON manifest under
nv_core/sr_specs/docs/features/:
- use the guide filename pattern
FET_###_base_<variant>-<version>-<description>.json
- include
id, version, display_name, path, and requirements
- include
dependencies only when the feature actually depends on other features
- use exact dependency versions
- avoid circular dependencies
- keep requirements explicit when feature expansion replaces a base requirement
- Create the feature markdown page under
nv_core/sr_specs/docs/features/:
- describe the runtime use case
- list properties, dependencies, profiles, and requirements
- link each requirement doc and validator implementation when available
- document testing, samples, manual review, and known gaps
- Update
nv_core/sr_specs/docs/features/features.md with the new feature row and toctree entry.
- Update
nv_core/sr_specs/docs/features/feature-dependency-graph.md when the feature has dependencies or affects common dependency diagrams.
- Add a conform skill for the new feature when the feature can produce asset-level validation failures:
- create
skills/simready-foundation-conform-fet-###-<feature-name>/SKILL.md
- include source-of-truth feature/requirement/validator paths
- define what the skill may repair automatically and what it must block on
- call out required model/tool capabilities, such as vision, CAD/source data, runtime simulation, or material identity
- update
assets/openai.yaml so the skill is discoverable
- if the feature is metadata-only, advisory-only, or cannot be repaired safely, document the reason in the feature summary and validation handoff
- If profile adoption is requested, hand off to
simready-foundation-add-profile or simready-foundation-update-profile; do not silently mutate an existing profile version.
- Validate consistency:
- JSON parses
- manifest
id and version match the requested feature
- every dependency feature/version exists
- every requirement ID is documented or intentionally new in the same change
- feature markdown and index links resolve by path/name
- the matching conform skill exists or the no-conform-skill rationale is documented
Examples
Example request:
Add a new SimReady Foundation feature FET025 for factory connection points and wire it into feature docs and manifests.
Expected result summary:
changed_files: new docs, manifests, indexes, or validation scaffolding
validation: focused static checks and any relevant docs/build checks
remaining_gaps: requirement, validator, adapter, profile, or runtime-test follow-up
Policies
- Feature versions are immutable once published or used by a profile.
- Keep the feature focused on one runtime promise.
- Do not include requirements just because they are nearby; include only what the feature needs.
- If a technology-specific feature replaces a neutral/base requirement, list the full replacement requirement set explicitly instead of depending on the base feature for conflicting rules.
- Treat the per-profile TOML files in
profiles/ as profile source of truth; feature docs should mention profile usage but not replace the TOML.
- Feature authoring and asset repair should evolve together. A new feature that introduces required authored USD data should normally ship with a conform skill for repairing or clearly blocking on that feature.
Limitations
- Do not mutate published feature or profile versions in place.
- Do not invent requirement IDs or validator behavior when the contract is ambiguous; record the question.
- Do not skip index, manifest, validation, or downstream follow-up notes.
Troubleshooting
- Error: the new concept overlaps an existing artifact. Solution: update the existing capability, requirement, feature, profile, or adapter instead.
- Error: names or IDs conflict. Solution: re-check naming conventions and nearby indexes before editing further.
- Error: validation strategy is unclear. Solution: document deferred validation and the exact follow-up skill.
Resources
assets/openai.yaml preserves optional UI metadata for clients that read skill display hints. It is not required for the workflow.
Summary Format
Report:
| Field |
Meaning |
feature_id |
New feature ID. |
version |
New feature version. |
feature_markdown |
Feature documentation path. |
feature_manifest |
JSON manifest path. |
requirements |
Requirement IDs included. |
dependencies |
Feature dependencies included. |
profiles_updated |
Profiles changed, or none. |
conform_skill |
New/updated conform skill path, or documented rationale for none. |
validation |
Checks run and remaining gaps. |
next_step |
Profile adoption, validator work, runtime test, or review. |
1---2name: simready-foundation-add-feature3description: Use for adding SimReady feature docs, manifests, requirement mappings, validation strategy, and index entries.4license: Apache-2.05---678# SimReady Add Feature910## Purpose11Use this skill to add a brand-new SimReady feature under `nv_core/sr_specs/docs/features/`. A feature is a versioned runtime/use-case contract made from exact requirement IDs and optional feature dependencies.1213Do not use this skill for a new version of an existing feature. Use `simready-foundation-update-feature` for that.1415## Prerequisites16Before editing, read:1718- `AGENTS.md`19- `nv_core/sr_specs/docs/guides/guides.md`20- `nv_core/sr_specs/docs/guides/features/features.md`21- `nv_core/sr_specs/docs/guides/naming_conventions.md`22- `nv_core/sr_specs/docs/features/features.md`23- existing neighboring feature markdown and JSON files for the same domain2425If the feature will be added to a profile, also read `nv_core/sr_specs/docs/guides/profiles/profiles.md` and the target profile markdown/TOML entries.2627## Inputs2829Collect or infer:3031| Input | Requirement |32|---|---|33| `feature_number` | Numeric ID such as `025`. If absent, inspect existing feature IDs and propose the next appropriate number. |34| `feature_id` | Exact ID such as `FET025_BASE_NEUTRAL`; must match the variant pattern used by existing JSON manifests. |35| `version` | Initial semantic version, usually `0.1.0` unless the user states otherwise. |36| `display_name` | Human-readable feature name. |37| `runtime_promise` | Concrete asset behavior the feature guarantees. |38| `requirements` | Existing requirement IDs or new requirement docs/validators needed by the feature. |39| `dependencies` | Exact feature IDs and versions this feature depends on. |40| `profile_targets` | Optional profiles and versions that should adopt the feature. |41| `validation_strategy` | Automated validator, runtime test, manual test, or documented gap. |42| `conform_skill_plan` | New conform skill name, existing conform skill to update, or documented reason no conform skill can safely repair the feature. |4344## Instructions4546Use this checklist when changing the repository:47481. Inspect existing feature numbers, IDs, filenames, and variant suffixes. Avoid reusing an ID or inventing a new suffix when an existing suffix matches.492. Define the runtime promise in asset terms before choosing requirements.503. Prefer existing requirements and validators. Add new requirement docs or validators only when the feature needs a new testable rule.514. Create the JSON manifest under `nv_core/sr_specs/docs/features/`:52 - use the guide filename pattern `FET_###_base_<variant>-<version>-<description>.json`53 - include `id`, `version`, `display_name`, `path`, and `requirements`54 - include `dependencies` only when the feature actually depends on other features55 - use exact dependency versions56 - avoid circular dependencies57 - keep requirements explicit when feature expansion replaces a base requirement585. Create the feature markdown page under `nv_core/sr_specs/docs/features/`:59 - describe the runtime use case60 - list properties, dependencies, profiles, and requirements61 - link each requirement doc and validator implementation when available62 - document testing, samples, manual review, and known gaps636. Update `nv_core/sr_specs/docs/features/features.md` with the new feature row and toctree entry.647. Update `nv_core/sr_specs/docs/features/feature-dependency-graph.md` when the feature has dependencies or affects common dependency diagrams.658. Add a conform skill for the new feature when the feature can produce asset-level validation failures:66 - create `skills/simready-foundation-conform-fet-###-<feature-name>/SKILL.md`67 - include source-of-truth feature/requirement/validator paths68 - define what the skill may repair automatically and what it must block on69 - call out required model/tool capabilities, such as vision, CAD/source data, runtime simulation, or material identity70 - update `assets/openai.yaml` so the skill is discoverable71 - if the feature is metadata-only, advisory-only, or cannot be repaired safely, document the reason in the feature summary and validation handoff729. If profile adoption is requested, hand off to `simready-foundation-add-profile` or `simready-foundation-update-profile`; do not silently mutate an existing profile version.7310. Validate consistency:74 - JSON parses75 - manifest `id` and `version` match the requested feature76 - every dependency feature/version exists77 - every requirement ID is documented or intentionally new in the same change78 - feature markdown and index links resolve by path/name79 - the matching conform skill exists or the no-conform-skill rationale is documented8081## Examples8283Example request:8485```text86Add a new SimReady Foundation feature FET025 for factory connection points and wire it into feature docs and manifests.87```8889Expected result summary:9091```text92changed_files: new docs, manifests, indexes, or validation scaffolding93validation: focused static checks and any relevant docs/build checks94remaining_gaps: requirement, validator, adapter, profile, or runtime-test follow-up95```9697## Policies9899- Feature versions are immutable once published or used by a profile.100- Keep the feature focused on one runtime promise.101- Do not include requirements just because they are nearby; include only what the feature needs.102- If a technology-specific feature replaces a neutral/base requirement, list the full replacement requirement set explicitly instead of depending on the base feature for conflicting rules.103- Treat the per-profile TOML files in `profiles/` as profile source of truth; feature docs should mention profile usage but not replace the TOML.104- Feature authoring and asset repair should evolve together. A new feature that introduces required authored USD data should normally ship with a conform skill for repairing or clearly blocking on that feature.105106## Limitations107108- Do not mutate published feature or profile versions in place.109- Do not invent requirement IDs or validator behavior when the contract is ambiguous; record the question.110- Do not skip index, manifest, validation, or downstream follow-up notes.111112## Troubleshooting113114- Error: the new concept overlaps an existing artifact. Solution: update the existing capability, requirement, feature, profile, or adapter instead.115- Error: names or IDs conflict. Solution: re-check naming conventions and nearby indexes before editing further.116- Error: validation strategy is unclear. Solution: document deferred validation and the exact follow-up skill.117118## Resources119120- `assets/openai.yaml` preserves optional UI metadata for clients that read skill display hints. It is not required for the workflow.121122## Summary Format123124Report:125126| Field | Meaning |127|---|---|128| `feature_id` | New feature ID. |129| `version` | New feature version. |130| `feature_markdown` | Feature documentation path. |131| `feature_manifest` | JSON manifest path. |132| `requirements` | Requirement IDs included. |133| `dependencies` | Feature dependencies included. |134| `profiles_updated` | Profiles changed, or `none`. |135| `conform_skill` | New/updated conform skill path, or documented rationale for none. |136| `validation` | Checks run and remaining gaps. |137| `next_step` | Profile adoption, validator work, runtime test, or review. |