docassert 0.1.0__py3-none-any.whl

docassert/_data/schema/raci-stakeholder.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "RACI / Stakeholder Register frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "raci-stakeholder"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Z]{2,6}-[a-z0-9][a-z0-9-]*$",
+      "description": "Stable id, <CODE>-<slug> (e.g. AUR-brd). The CODE namespaces it to the owning project. Unique across documents/."
+    },
+    "title": {
+      "type": "string",
+      "minLength": 3
+    },
+    "owner": {
+      "type": "string",
+      "minLength": 2
+    },
+    "status": {
+      "enum": [
+        "draft",
+        "proposed",
+        "approved",
+        "baselined"
+      ]
+    },
+    "project": {
+      "type": "string",
+      "pattern": "^PRJ-\\d{3,}-[A-Z]{2,6}$",
+      "description": "Owning project's canonical id, PRJ-NNN-CODE (e.g. PRJ-001-AUR)."
+    }
+  }
+}

docassert/_data/schema/release-cutover-plan.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Release / Cutover Plan frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "release-cutover-plan"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Z]{2,6}-[a-z0-9][a-z0-9-]*$",
+      "description": "Stable id, <CODE>-<slug> (e.g. AUR-brd). The CODE namespaces it to the owning project. Unique across documents/."
+    },
+    "title": {
+      "type": "string",
+      "minLength": 3
+    },
+    "owner": {
+      "type": "string",
+      "minLength": 2
+    },
+    "status": {
+      "enum": [
+        "draft",
+        "proposed",
+        "approved",
+        "baselined"
+      ]
+    },
+    "project": {
+      "type": "string",
+      "pattern": "^PRJ-\\d{3,}-[A-Z]{2,6}$",
+      "description": "Owning project's canonical id, PRJ-NNN-CODE (e.g. PRJ-001-AUR)."
+    }
+  }
+}

docassert/_data/schema/risk-register.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Risk Register frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "risk-register"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Z]{2,6}-[a-z0-9][a-z0-9-]*$",
+      "description": "Stable id, <CODE>-<slug> (e.g. AUR-brd). The CODE namespaces it to the owning project. Unique across documents/."
+    },
+    "title": {
+      "type": "string",
+      "minLength": 3
+    },
+    "owner": {
+      "type": "string",
+      "minLength": 2
+    },
+    "status": {
+      "enum": [
+        "draft",
+        "proposed",
+        "approved",
+        "baselined"
+      ]
+    },
+    "project": {
+      "type": "string",
+      "pattern": "^PRJ-\\d{3,}-[A-Z]{2,6}$",
+      "description": "Owning project's canonical id, PRJ-NNN-CODE (e.g. PRJ-001-AUR)."
+    }
+  }
+}

docassert/_data/schema/rollback-plan.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Rollback Plan frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "rollback-plan"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Z]{2,6}-[a-z0-9][a-z0-9-]*$",
+      "description": "Stable id, <CODE>-<slug> (e.g. AUR-brd). The CODE namespaces it to the owning project. Unique across documents/."
+    },
+    "title": {
+      "type": "string",
+      "minLength": 3
+    },
+    "owner": {
+      "type": "string",
+      "minLength": 2
+    },
+    "status": {
+      "enum": [
+        "draft",
+        "proposed",
+        "approved",
+        "baselined"
+      ]
+    },
+    "project": {
+      "type": "string",
+      "pattern": "^PRJ-\\d{3,}-[A-Z]{2,6}$",
+      "description": "Owning project's canonical id, PRJ-NNN-CODE (e.g. PRJ-001-AUR)."
+    }
+  }
+}

docassert/_data/schema/runbook.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Runbook frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "runbook"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Z]{2,6}-[a-z0-9][a-z0-9-]*$",
+      "description": "Stable id, <CODE>-<slug> (e.g. AUR-brd). The CODE namespaces it to the owning project. Unique across documents/."
+    },
+    "title": {
+      "type": "string",
+      "minLength": 3
+    },
+    "owner": {
+      "type": "string",
+      "minLength": 2
+    },
+    "status": {
+      "enum": [
+        "draft",
+        "proposed",
+        "approved",
+        "baselined"
+      ]
+    },
+    "project": {
+      "type": "string",
+      "pattern": "^PRJ-\\d{3,}-[A-Z]{2,6}$",
+      "description": "Owning project's canonical id, PRJ-NNN-CODE (e.g. PRJ-001-AUR)."
+    }
+  }
+}

docassert/_data/schema/status-report.schema.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Status Report frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "period",
+    "rag",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "status-report"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Z]{2,6}-[a-z0-9][a-z0-9-]*$",
+      "description": "Stable id, <CODE>-<slug> (e.g. AUR-brd). The CODE namespaces it to the owning project. Unique across documents/."
+    },
+    "title": {
+      "type": "string",
+      "minLength": 3
+    },
+    "owner": {
+      "type": "string",
+      "minLength": 2
+    },
+    "period": {
+      "type": "string",
+      "format": "date"
+    },
+    "rag": {
+      "enum": [
+        "green",
+        "amber",
+        "red"
+      ]
+    },
+    "status": {
+      "enum": [
+        "draft",
+        "proposed",
+        "approved",
+        "baselined"
+      ]
+    },
+    "project": {
+      "type": "string",
+      "pattern": "^PRJ-\\d{3,}-[A-Z]{2,6}$",
+      "description": "Owning project's canonical id, PRJ-NNN-CODE (e.g. PRJ-001-AUR)."
+    }
+  }
+}

docassert/_data/schema/test-cases.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Test Cases frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "test-cases"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Z]{2,6}-[a-z0-9][a-z0-9-]*$",
+      "description": "Stable id, <CODE>-<slug> (e.g. AUR-brd). The CODE namespaces it to the owning project. Unique across documents/."
+    },
+    "title": {
+      "type": "string",
+      "minLength": 3
+    },
+    "owner": {
+      "type": "string",
+      "minLength": 2
+    },
+    "status": {
+      "enum": [
+        "draft",
+        "proposed",
+        "approved",
+        "baselined"
+      ]
+    },
+    "project": {
+      "type": "string",
+      "pattern": "^PRJ-\\d{3,}-[A-Z]{2,6}$",
+      "description": "Owning project's canonical id, PRJ-NNN-CODE (e.g. PRJ-001-AUR)."
+    }
+  }
+}

docassert/_data/schema/user-story.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "User Stories frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "user-story"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Z]{2,6}-[a-z0-9][a-z0-9-]*$",
+      "description": "Stable id, <CODE>-<slug> (e.g. AUR-brd). The CODE namespaces it to the owning project. Unique across documents/."
+    },
+    "title": {
+      "type": "string",
+      "minLength": 3
+    },
+    "owner": {
+      "type": "string",
+      "minLength": 2
+    },
+    "status": {
+      "enum": [
+        "draft",
+        "proposed",
+        "approved",
+        "baselined"
+      ]
+    },
+    "project": {
+      "type": "string",
+      "pattern": "^PRJ-\\d{3,}-[A-Z]{2,6}$",
+      "description": "Owning project's canonical id, PRJ-NNN-CODE (e.g. PRJ-001-AUR)."
+    }
+  }
+}

docassert/_data/templates/adr.template.md

@@ -0,0 +1,17 @@
+---
+kind: adr
+id: my-adr-log
+title: My Architecture Decision Log
+owner: jane.doe
+status: draft
+---
+
+## Overview
+
+<!-- What area these decisions cover. -->
+
+## Decisions
+
+<!-- Each decision optionally affects a requirement and MUST declare a Status. -->
+
+- **ADR-001** (affects: FR-001): <!-- title -->. Status: accepted. Context: <!-- … -->. Decision: <!-- … -->. Consequences: <!-- … -->.

docassert/_data/templates/benefits-realization.template.md

@@ -0,0 +1,25 @@
+---
+kind: benefits-realization
+id: my-benefits
+title: My Benefits Realization Plan
+owner: jane.doe
+status: draft
+---
+
+## Overview
+
+<!-- Which benefits this tracks and against which business case / charter. -->
+
+## Benefits
+
+<!-- Each benefit must state a measurable target. -->
+
+- <!-- e.g. Reduce support tickets by at least 80% within two quarters -->
+
+## Measurement
+
+<!-- How and when each benefit is measured, and by whom. -->
+
+## Realized Value
+
+<!-- Actuals to date against each target. -->

docassert/_data/templates/brd.template.md

@@ -0,0 +1,22 @@
+---
+kind: brd
+id: my-brd
+title: My Business Requirements Document
+owner: jane.doe
+status: draft   # draft | proposed | approved | baselined
+---
+
+## Purpose
+
+<!-- Why this initiative exists, in business terms. -->
+
+## Business Requirements
+
+<!-- One bullet per requirement, each a **BR-###** item. -->
+
+- **BR-001**: <!-- The business shall … -->
+- **BR-002**: <!-- … -->
+
+## Out of Scope
+
+<!-- What this explicitly does not cover. -->

docassert/_data/templates/business-case.template.md

@@ -0,0 +1,27 @@
+---
+kind: business-case
+id: my-business-case
+title: My Business Case
+sponsor: jane.doe
+status: draft
+---
+
+## Problem Statement
+
+<!-- The problem or opportunity, in business terms. -->
+
+## Options Considered
+
+<!-- The options evaluated, including "do nothing". -->
+
+## Recommendation
+
+<!-- The recommended option and why. -->
+
+## Costs
+
+<!-- Cost estimate and basis. -->
+
+## Benefits
+
+<!-- Expected benefits; tie these to the charter's success criteria. -->

docassert/_data/templates/charter.template.md

@@ -0,0 +1,46 @@
+---
+kind: charter
+id: my-project            # lowercase, hyphenated, unique across documents/
+title: My Project Charter
+sponsor: jane.doe         # the accountable individual, not a team
+budget:
+  amount: 500000         # a positive number
+  currency: USD          # ISO 4217, three uppercase letters
+dates:
+  created: 2026-01-15
+  target: 2026-12-31     # on or after created
+status: draft            # draft | proposed | approved
+---
+
+## Objective
+
+<!-- One paragraph. State the outcome this project will produce and why it
+matters. Be specific and measurable, not a restatement of the project name. -->
+
+## Success Criteria
+
+<!-- A bulleted list. Every criterion must state a measurable threshold
+(a number, percentage, currency, or date), so pass/fail is unambiguous. -->
+
+- <!-- e.g. Onboarding p50 drops below 48 hours -->
+- <!-- e.g. CSAT rises above 4.5 / 5 -->
+
+## Scope
+
+<!-- What is in scope, and explicitly what is out of scope. -->
+
+## Milestones
+
+<!-- A bulleted or tabular list of dated milestones. -->
+
+- <!-- e.g. MVP — 2026-09-30 -->
+
+## Risks
+
+<!-- One bullet per risk. Every risk MUST name an Owner and a Mitigation. -->
+
+- <!-- e.g. Data migration may slip the MVP. Owner: alex.kim. Mitigation: dual-run with a manual CSV fallback. -->
+
+## Approval
+
+<!-- Who approves this charter and under what conditions. -->

docassert/_data/templates/data-migration-plan.template.md

@@ -0,0 +1,35 @@
+---
+kind: data-migration-plan
+id: my-data-migration
+title: My Data Migration Plan
+owner: jane.doe
+status: draft
+---
+
+## Scope
+
+<!-- What data moves, from where to where. -->
+
+## Source Systems
+
+<!-- The systems and stores data comes from. -->
+
+## Field Mapping
+
+<!-- A table mapping source fields to target fields. -->
+
+| Source field | Target field | Transform |
+|---|---|---|
+| src_field | target.field | <!-- transform --> |
+
+## Validation
+
+<!-- How correctness is verified after migration. -->
+
+## Cutover
+
+<!-- The cutover sequence. -->
+
+## Rollback
+
+<!-- How to revert if the migration fails. -->

docassert/_data/templates/frnfr.template.md

@@ -0,0 +1,19 @@
+---
+kind: frnfr
+id: my-frnfr
+title: My Functional & Non-Functional Requirements
+owner: jane.doe
+status: draft
+---
+
+## Overview
+
+<!-- What this specification covers. -->
+
+## Functional Requirements
+
+- **FR-001** (traces: PR-001): <!-- The system shall … -->
+
+## Non-Functional Requirements
+
+- **NFR-001** (traces: PR-001): <!-- The system shall … (performance, security, …) -->

docassert/_data/templates/hypercare-plan.template.md

@@ -0,0 +1,29 @@
+---
+kind: hypercare-plan
+id: my-hypercare-plan
+title: My Hypercare Plan
+owner: jane.doe
+status: draft
+---
+
+## Overview
+
+<!-- What hypercare covers and for how long. -->
+
+## Support Window
+
+<!-- Dates/hours of heightened support. -->
+
+## Severity Levels
+
+<!-- Definitions and response targets for SEV-1 / SEV-2 / SEV-3. -->
+
+## Escalation
+
+<!-- Who is paged and when. -->
+
+## Exit Criteria
+
+<!-- Each exit criterion must state a measurable threshold. -->
+
+- <!-- e.g. fewer than 2 SEV-2 incidents over 5 consecutive days -->

docassert/_data/templates/post-implementation-review.template.md

@@ -0,0 +1,31 @@
+---
+kind: post-implementation-review
+id: my-pir
+title: My Post-Implementation Review
+owner: jane.doe
+status: draft
+---
+
+## Summary
+
+<!-- What was delivered and the overall verdict. -->
+
+## Outcomes vs Objectives
+
+<!-- Actual outcomes against the charter's objective and success criteria. -->
+
+## What Went Well
+
+<!-- … -->
+
+## What Could Improve
+
+<!-- … -->
+
+## Lessons Learned
+
+<!-- … -->
+
+## Follow-up Actions
+
+<!-- Owned, dated actions arising from this review. -->

docassert/_data/templates/prd.template.md

@@ -0,0 +1,23 @@
+---
+kind: prd
+id: my-prd
+title: My Product Requirements Document
+owner: jane.doe
+status: draft
+---
+
+## Overview
+
+<!-- What the product does and for whom. -->
+
+## Product Requirements
+
+<!-- Each requirement traces to one or more business requirements. -->
+
+- **PR-001** (traces: BR-001): <!-- The product shall … -->
+
+## Acceptance Criteria
+
+<!-- Each criterion verifies a product requirement. -->
+
+- **AC-001** (verifies: PR-001): <!-- Given …, when …, then … -->

docassert/_data/templates/project.template.md

@@ -0,0 +1,17 @@
+---
+kind: project
+id: PRJ-000-XXX          # PRJ-<sequence>-<CODE>; unique across all projects
+code: XXX                # 2–6 uppercase letters; namespaces this project's ids
+name: <Project name>
+sponsor: <accountable individual>
+status: proposed         # proposed | active | on-hold | closed
+---
+
+## Overview
+
+<!-- One paragraph: what this project is and the outcome it exists to deliver.
+     The charter carries the detail; this anchor just establishes identity. -->
+
+## Scope
+
+<!-- In scope / out of scope at the project level. -->