Skip to content
mirageglobePublic

About

AI agent aware technical specification for both engineers and agents

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

spec-md

License: MIT

website: https://mirageglobe.github.io/spec-md

a standard for technical project specifications — the blueprint every codebase needs.


what is spec-md?

spec-md is a structured markdown format for the SPEC.md file. it defines a common schema for architecture documents, design decisions, roadmaps, and complexity scoring — so developers and AI agents can navigate any project with the same mental model.

think of it like agents.md for agent behavior, or .editorconfig for code style — but for project architecture documentation.


why

most projects either have no technical spec, or have one buried in a wiki that goes stale. spec-md is:

  • file-first: lives in the repo, versioned with the code.
  • agent-readable: structured sections and explicit tags make it easy for LLMs to scope work.
  • human-readable: plain markdown, no tooling required.
  • opinionated but minimal: defines what goes where, not how much to write.

quick start

copy template/SPEC.md to your repo root and fill in each section.


see SPEC.md for the schema reference, section definitions, and website architecture.


MIT License — copyright (c) 2026 Jimmy MG Lim — buy me a coffee

About

AI agent aware technical specification for both engineers and agents

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages