Templates/component-template.md

Component Template

Use this template to describe a software component and its relationships.

Markdown Schema Convention

Any file with a first heading that starts with # Component: is treated as a component document and must follow this schema.

Field	Required	Type	Description
`name`	Yes	String	Unique component name.
`description`	Yes	Paragraph	Short explanation of what the component does.
`usedBy`	Yes	Bullet list	Components, applications, or services that use this component.
`dependsOn`	Yes	Bullet list	Components, services, or platforms this component depends on.
`sourceCode`	No	Bullet list	Link to source repository or folder where the component is defined.
`supportTeam`	No	Paragraph	Team responsible for support and maintenance.
`environments`	No	Bullet list	Environments where this component is deployed or used.
`status`	No	Paragraph	Lifecycle state (for example `active`, `deprecated`, `retired`).
`notes`	No	Paragraph	Extra context not captured by other fields.

Required Section Headings

# Component: <name>
## Description
## Used By
## Depends On

Optional Section Headings

## Source Code
## Support Team
## Environments
## Status
## Notes

Ontology Relationships

usedBy: incoming relationship from consumers to this component.
dependsOn: outgoing relationship from this component to upstream dependencies.

Markdown Record Template

# Component: <component-name>

## Description
<what this component does>

## Used By
- <consumer-1>
- <consumer-2>

## Depends On
- <dependency-1>
- <dependency-2>

## Source Code
- [Repository](https://github.com/org/repo/tree/main/path)

## Support Team
<team-name>

## Environments
- dev
- test
- prod

## Status
active

## Notes
<optional extra context>

Example

# Component: Billing API

## Description
Provides billing and invoice operations for internal and external consumers.

## Used By
- Customer Portal
- Finance Reconciliation Job

## Depends On
- Auth Service
- Payments Gateway

## Source Code
- [Billing API Repo](https://github.com/example-org/platform-services/tree/main/billing-api)

## Support Team
Payments Platform Team

## Environments
- test
- prod

## Status
active

## Notes
Consumes payment events asynchronously for reconciliation.