describe-phase-file

Define and enforce the required structure for phase.md files.

7|1|Updated Jan 27, 2026

Search Tags:#workflow #documentation #governance #frontmatter #acceptance-criteria #phase #phase.md

Ready to run

npx skills add https://github.com/adamrdrew/ushabti --skill describe-phase-file

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: describe-phase-file
Source: https://github.com/adamrdrew/ushabti/tree/main/skills/describe-phase-file
Command: npx skills add https://github.com/adamrdrew/ushabti --skill describe-phase-file

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Defines a standardized structure for phase.md to ensure consistent documentation of phase intents, scopes, constraints, acceptance criteria, and notes.

Core Features & Use Cases

Enforces a consistent frontmatter and body format for phase.md to support repeatable phase definitions.
Clarifies the mandatory sections (Intent, Scope, Constraints, Acceptance criteria, Risks) and optional card metadata for traceability.
Improves governance and auditability of phase definitions across projects using Overseer.

Quick Start

Create a phase.md with the required frontmatter and the five mandatory sections described above.

Frequently Asked Questions about describe-phase-file

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

What sections are required in a phase.md file for project governance?▼

A phase.md file requires five mandatory sections: Intent, Scope, Constraints, Acceptance criteria, and Risks. It also requires specific frontmatter fields and supports optional card metadata for traceability.

How do I enforce consistent phase documentation structure across projects?▼

You can enforce consistent phase documentation by applying a standardized phase.md structure that specifies exact frontmatter fields and requires the Intent, Scope, Constraints, Acceptance criteria, and Risks sections.

Does phase.md require frontmatter for acceptance criteria and traceability?▼

Yes, phase.md requires specific frontmatter fields to support governance and auditability. It also allows optional card metadata to ensure traceability of phase definitions across projects using Overseer.

What is the best way to document phase scope and constraints for audits?▼

The best way to document phase scope and constraints for audits is to use a standardized phase.md format with mandatory sections for Scope and Constraints, ensuring consistent governance and traceability across projects.

Can I add custom metadata to phase.md beyond the mandatory sections?▼

Yes, beyond the mandatory frontmatter and the five required sections, phase.md supports optional card metadata. This allows you to add traceability information while maintaining the core governance structure.