Skip to content

raiworks/mastery.md

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MASTERY.md

Current: v3.3.0 · Changelog · Website

A universal, tech-agnostic development process framework — one Markdown file that defines how software projects should be structured, discussed, designed, planned, built, shipped, and reflected upon.

What Is This?

MASTERY.md is a single Markdown file (mastery.md) that codifies the entire development lifecycle for any software project. Copy it into your project's docs/ folder and follow its process — whether you're a solo developer, a small team, or an AI coding agent.

It comes in two variants:

Variant File Tokens Best For
Full mastery.md ~25k Complete reference with all 16 document templates, hotfix workflows, and advanced guidance
Compact mastery-compact.md ~5k AI agent context loading — all rules and lifecycle stages, no templates

Both files are the same framework. The compact variant drops templates and rarely-needed reference sections to save ~80% of tokens. AI agents load the compact file every session and pull specific templates from the full file only when creating new documents.

It provides:

  • 7-stage lifecycle: Discuss → Design → Plan → Approve → Build → Ship → Reflect
  • Document templates: Project discussion, context, roadmap, feature specs, task lists, and more
  • AI Agent Protocol: Rules for how AI assistants should read context, make decisions, and ask for help
  • Git conventions: Branching strategy, commit message format, and merge workflow
  • Session continuity: Structured docs that let any human or AI pick up where work left off

Why?

AI coding agents are powerful but directionless without process. They'll start coding without understanding the project, repeat mistakes, and lose context between sessions. Human developers face similar problems at smaller scale.

Mastery solves this by giving every project the same structured process — documented in a single file that both humans and AI agents can read and follow.

Zero dependencies. Pure Markdown. No tooling, no runtime, no packages — works with any language, any stack, any editor.

Quick Start

  1. Copy mastery.md and mastery-compact.md into your project's docs/ directory
  2. Read the compact file to understand rules and lifecycle (or full file for templates)
  3. Create docs/project-discussion.md using the embedded template
  4. Follow the lifecycle: Discuss → Design → Plan → Approve → Build → Ship → Reflect
your-project/
├── docs/
│   ├── mastery.md              # Full framework (read-only — never edit this)
│   ├── mastery-compact.md      # Compact variant for AI agents (read-only)
│   ├── project-discussion.md   # First: discuss what you're building
│   ├── project-context.md      # Then: formalize the project identity
│   ├── project-roadmap.md      # Then: plan the feature order
│   └── features/               # Per-feature lifecycle docs
│       └── 01-feature-name/
├── src/                        # Your code
└── ...

Key Principles

  • Read-only framework: Never edit mastery.md in your project. Customizations go in docs/references/process-overrides.md.
  • Docs before code: Discuss, design, and plan before building. This saves time, not costs it.
  • One source of truth: Each document has a clear purpose. No duplicated or conflicting information.
  • AI-native: Every document is designed to be loaded by AI agents as context for productive work.

Adopting Mastery

Step Action
1 Copy mastery.md and mastery-compact.md to docs/ in your project
2 Create .gitignore rules if you want docs private
3 Follow the Project Initialization flow in the framework
4 When Mastery updates, replace both copies with the new versions

Versioning

This framework uses semantic versioning:

  • Major (v2 → v3): Breaking changes to process, templates, or structure
  • Minor (v3.0 → v3.1): New features, templates, or guidance added
  • Patch (v3.0.0 → v3.0.1): Fixes, clarifications, typo corrections

See CHANGELOG.md for version history.

License

MIT — use freely in any project, commercial or open source.

Mastery MCP Server

An optional companion tool that gives AI agents native access to Mastery docs through the Model Context Protocol.

14 tools for reading project context, roadmaps, features, tasks, test plans, reviews, and more. 11 resources for direct document access via mastery:// URIs — including mastery://mastery-compact for the compact variant.

The server watches your docs/ folder and serves structured, parsed content — so AI agents can query your project state without reading raw files.

Works with VS Code (GitHub Copilot), Claude Desktop, Cursor, and any MCP-compatible client.

Contributing

Contributions are welcome. Please open an issue to discuss proposed changes before submitting a pull request.

About

A universal, tech-agnostic development process framework distributed as a single Markdown file. Defines a complete AI-ready software lifecycle: Discuss → Design → Plan → Approve → Build → Ship → Reflect.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors