OSVauco/docs/templates/component_manifest.md

83 lines
3.3 KiB
Markdown

# INCU Component Manifest Template
**Status:** Reusable draft template<br>
**Governing standard:** [`INCU Master Constitution`](../INCU_Master_Constitution.md)<br>
**Runtime effect:** None<br>
> Complete this template before a consequential agent, tool, connector, automation, workflow participant, operator, verifier, or integration is proposed for activation. A completed manifest does not itself grant permission, activate the component, replace human approval, or override platform IAM.
## Identity
- Component ID: `<stable unique identifier>`
- Class: `<one manifest class>`
- Version: `<semantic version>`
- Owner: `<human/team accountable for this component>`
- Status: draft | approved | active | paused | revoked | deprecated | retired
- Review date: `<date>`
## Purpose
- Intended outcome: `<one sentence>`
- Value to system: `<why this component exists>`
- Explicit non-goals: `<what it must not do>`
## Scope
- Permitted tasks: `<bounded list>`
- Prohibited tasks: `<bounded list>`
- Supported systems/environments: `<e.g. staging only, named repositories only>`
- Time/cost/retry limits: `<limits>`
## Authority
- Read permissions: `<systems and data classes>`
- Write permissions: `<systems and exact allowed mutations>`
- Approval requirement: `<none / user confirmation / named owner / policy gate>`
- Delegation rules: `<who can invoke this component>`
- Revocation method: `<how access is disabled immediately>`
## Inputs and Outputs
- Required inputs: `<schema or references>`
- Optional inputs: `<schema>`
- Outputs: `<schema and artifact locations>`
- Source of truth: `<A2HA, Git, CI, cloud provider, etc.>`
- Evidence format: `<tests, links, logs, signatures, records>`
## INCU Mandate
- Outcome statement format: `<format>`
- Startability rule: `<specific first action policy>`
- Applicable levers: Interest | Novelty | Challenge | Urgency | Purpose
- Boundedness rule: `<scope/time/retry limit>`
- Restart artifact: `<required format>`
- Blocker behavior: `<state and escalation>`
## Safety and Governance
- Data classification: `<public/internal/confidential/sensitive>`
- Security constraints: `<identity, network, secret, environment rules>`
- Privacy constraints: `<collection, consent, retention, deletion>`
- Stop conditions: `<when it must stop>`
- Escalation path: `<who/what receives the escalation>`
- Audit events: `<propose, approve, execute, result, failure>`
## A2HA Contract
- Ticket fields read: `<list>`
- Ticket fields written: `<list, default none>`
- Allowed state transitions: `<list>`
- Required evidence before transition: `<list>`
- Comment/update policy: `<preview/confirmation requirements>`
## Evaluation
- Acceptance tests: `<test scenarios>`
- Reliability metrics: `<error, latency, correctness>`
- Safety metrics: `<unauthorized-write rate, policy failures>`
- Review/rollback procedure: `<how to pause, remediate, and retire>`
---
## Completion rules
- No section may be omitted.
- Use `not applicable` only with a rationale.
- Read and write permissions must be declared separately.
- Every write authority requires an explicit approval rule.
- A `draft`, `paused`, `revoked`, `stale`, or `out_of_scope` component must
not participate in consequential execution.
- This document does not grant permission, activate the component, or allow
self-approval or scope expansion.