docassert 0.1.0__py3-none-any.whl

docassert/_data/criteria/user-story.criteria.yaml

@@ -0,0 +1,32 @@
+# Audit criteria for the User Stories kind.
+kind: user-story
+
+required_sections:
+  - Overview
+  - User Stories
+
+item_sections:
+  - section: User Stories
+    prefix: US
+
+checks:
+  - id: frontmatter-schema
+    type: structural
+    blocking: true
+    description: Frontmatter is valid against schema/user-story.schema.json.
+  - id: required-sections
+    type: structural
+    blocking: true
+    description: Every required section is present and non-empty.
+  - id: items-well-formed
+    type: structural
+    blocking: true
+    description: Every story is a valid **US-###** item.
+  - id: story-format
+    type: structural
+    blocking: true
+    description: Every story follows "As a … I want … so that …".
+  - id: unique-id
+    type: structural
+    blocking: true
+    description: The document id is unique across documents/.

docassert/_data/profiles/agile-delivery.yaml

@@ -0,0 +1,20 @@
+# Profile: agile-delivery
+#
+# User-story-centric. Stories carry acceptance criteria, every story traces to a
+# product requirement, and every acceptance criterion needs a test case. For
+# teams working in stories, not specs.
+name: agile-delivery
+description: >
+  Story-led delivery: charter, product requirements, user stories, and tests.
+
+enforce_when: active
+
+expects:
+  required:
+    - charter
+    - prd
+    - user-story
+    - test-cases
+  recommended:
+    - brd
+    - risk-register

docassert/_data/profiles/lean-startup.yaml

@@ -0,0 +1,19 @@
+# Profile: lean-startup
+#
+# A handful of kinds. Coverage stays advisory until you grow, so a small team is
+# never blocked for unfinished downstream docs. Start here.
+name: lean-startup
+description: >
+  The minimum spine: a charter, requirements, and tests. For a small team that
+  wants the gate without the ceremony.
+
+enforce_when: active
+
+expects:
+  required:
+    - charter
+    - brd
+    - prd
+    - test-cases
+  recommended:
+    - risk-register

docassert/_data/profiles/regulated-industry.yaml

@@ -0,0 +1,31 @@
+# Profile: regulated-industry
+#
+# The expected document set for a project on this profile. `required` kinds must
+# exist and be complete (present + approved/baselined + passing audit); a missing
+# required kind blocks CI once the project reaches `enforce_when`. `recommended`
+# kinds are surfaced as gaps on the project page but never block.
+name: regulated-industry
+description: >
+  Strictest set. For finance, healthcare, or government — the full governance
+  spine, from business case through benefits realization.
+
+# Completeness blocks the merge only once the project's status reaches this
+# lifecycle stage (proposed projects show gaps as advisory, never blocking).
+enforce_when: active
+
+expects:
+  required:
+    - charter
+    - business-case
+    - brd
+    - prd
+    - frnfr
+    - test-cases
+    - risk-register
+    - raci-stakeholder
+    - qa-test-plan
+  recommended:
+    - adr
+    - runbook
+    - status-report
+    - benefits-realization

docassert/_data/schema/adr.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Architecture Decision Record (log) frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "adr"
+    },
+    "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/benefits-realization.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Benefits Realization frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "benefits-realization"
+    },
+    "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/brd.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Business Requirements Document frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "brd"
+    },
+    "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/business-case.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Business Case frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "sponsor",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "business-case"
+    },
+    "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
+    },
+    "sponsor": {
+      "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/charter.schema.json

@@ -0,0 +1,84 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://pmo-as-code/schema/charter.schema.json",
+  "title": "Project Charter frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "sponsor",
+    "budget",
+    "dates",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "charter"
+    },
+    "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
+    },
+    "sponsor": {
+      "type": "string",
+      "minLength": 2,
+      "description": "The accountable individual. A name or handle, not a team."
+    },
+    "budget": {
+      "type": "object",
+      "required": [
+        "amount",
+        "currency"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "amount": {
+          "type": "number",
+          "exclusiveMinimum": 0
+        },
+        "currency": {
+          "type": "string",
+          "pattern": "^[A-Z]{3}$"
+        }
+      }
+    },
+    "dates": {
+      "type": "object",
+      "required": [
+        "created",
+        "target"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "created": {
+          "type": "string",
+          "format": "date"
+        },
+        "target": {
+          "type": "string",
+          "format": "date"
+        }
+      }
+    },
+    "status": {
+      "enum": [
+        "draft",
+        "proposed",
+        "approved"
+      ]
+    },
+    "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/data-migration-plan.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Data Migration Plan frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "data-migration-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/frnfr.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Functional / Non-Functional Requirements frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "frnfr"
+    },
+    "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/hypercare-plan.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Hypercare Plan frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "hypercare-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/post-implementation-review.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Post-Implementation Review frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "post-implementation-review"
+    },
+    "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/prd.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Product Requirements Document frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "prd"
+    },
+    "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/project.schema.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://pmo-as-code/schema/project.schema.json",
+  "title": "Project anchor frontmatter",
+  "type": "object",
+  "required": ["kind", "id", "code", "name", "sponsor", "status"],
+  "additionalProperties": true,
+  "properties": {
+    "kind": { "const": "project" },
+    "id": {
+      "type": "string",
+      "pattern": "^PRJ-\\d{3,}-[A-Z]{2,6}$",
+      "description": "Canonical project id, PRJ-NNN-CODE (e.g. PRJ-001-AUR). Unique across all projects."
+    },
+    "code": {
+      "type": "string",
+      "pattern": "^[A-Z]{2,6}$",
+      "description": "Short mnemonic that namespaces this project's document ids and item ids (e.g. AUR). Matches the id tail."
+    },
+    "name": { "type": "string", "minLength": 3 },
+    "sponsor": {
+      "type": "string",
+      "minLength": 2,
+      "description": "The accountable individual. A name or handle, not a team."
+    },
+    "status": { "enum": ["proposed", "active", "on-hold", "closed"] },
+    "profile": {
+      "type": "string",
+      "description": "Optional. Names a profiles/<name>.yaml that defines this project's expected document set (required/recommended kinds)."
+    }
+  }
+}

docassert/_data/schema/qa-test-plan.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "QA / Test Plan frontmatter",
+  "type": "object",
+  "required": [
+    "kind",
+    "id",
+    "project",
+    "title",
+    "owner",
+    "status"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "kind": {
+      "const": "qa-test-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)."
+    }
+  }
+}