generated from coulomb/repo-seed
Contract framework with markdown-native contracts utilizing fenced YAML blocks
This commit is contained in:
31
examples/documents/prd-frs-valid.md
Normal file
31
examples/documents/prd-frs-valid.md
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
document_type: prd-frs
|
||||
product: Markitect Tool
|
||||
owner: Platform Architecture
|
||||
---
|
||||
|
||||
# Markitect Tool PRD And FRS
|
||||
|
||||
## Problem
|
||||
|
||||
Markdown pipelines often check document shape without knowing whether the
|
||||
sections contain the content needed by authors, reviewers, and generation
|
||||
agents.
|
||||
|
||||
## Goals
|
||||
|
||||
The product should make document contracts testable. Success metrics include
|
||||
clear diagnostics, stable CLI behavior, and examples that show how contracts
|
||||
apply to real document types.
|
||||
|
||||
## Functional Requirements
|
||||
|
||||
- Load Markdown contract files with fenced YAML contract blocks.
|
||||
- Check required fields and section presence.
|
||||
- Report metric bands and deterministic assertions.
|
||||
- Produce machine-readable and human-readable diagnostics.
|
||||
|
||||
## Non-Goals
|
||||
|
||||
The first release does not execute provider-specific LLM calls or provide a UI
|
||||
form renderer.
|
||||
Reference in New Issue
Block a user