Skip to content

Latest commit

 

History

History
20 lines (16 loc) · 1.65 KB

resource-template.md

File metadata and controls

20 lines (16 loc) · 1.65 KB

Resource entry template

Copy the section below into resources.md, replace placeholders, and remove guidance that does not apply. Use unknown or not assessed instead of guessing.

Resource name

  • Purpose: The concrete modeling task it supports.
  • Tasks/categories: Build, analyze, validate, or supporting infrastructure; relevant categories.
  • Interfaces: CLI, SDK/languages, editor protocol, API, file formats, desktop/web interface.
  • License/access: SPDX identifier with a source link, or clearly stated commercial/mixed/unknown terms. Separate bundled libraries where needed.
  • Host/service requirements: Required proprietary host, account, subscription or API access, or none documented. Keep this separate from the resource's source license.
  • Specification target: Exact supported SysML/KerML/API version and its source, or not assessed.
  • Getting started: Link to upstream installation and a small useful workflow.
  • Limits: Supported subsets, known limitations, integration constraints, or not assessed.
  • Maintenance: Sourced lifecycle notice or dated activity observation; otherwise not assessed.
  • Evidence: Discovered, documentation reviewed, or locally tested; identify the claims covered.
  • Last reviewed: YYYY-MM-DD and the scope of the review.
  • Sources: Canonical repository, documentation, license, releases, and specific capability/limitation pages.

For local tests, link a separate note recording exact tool and library artifacts, model inputs, environment, commands, expected behavior and basis, observed outputs, and unresolved questions. Do not put raw credentials or private endpoints in public notes.