README
¶
SpecScore
The open specification standard for AI-driven development
SpecScore is an open specification format that makes requirements machine-readable without making them human-unreadable. It's Markdown and YAML — version-controlled, portable, no vendor lock-in. A linter and LSP catch ambiguity before your agents do. Use it standalone or with any orchestration tool.
Read the Spec · specscore.md · Ecosystem
Quick Start
# Install the CLI
go install github.com/synchestra-io/specscore/tools/cli@latest
# Lint your first spec
specscore lint ./spec
Full installation guide: docs/installation.md
What SpecScore Defines
SpecScore provides a structured format for:
- Features — user-facing capabilities with requirements and acceptance criteria
- Requirements — scoped, testable conditions that define done
- Acceptance Criteria — machine-readable conditions tied to features and tasks
- Plans — ordered sequences of tasks that bridge specs to implementation
- Tasks — atomic units of work assigned to agents or people
- Source References — traceable links from specs to code and back
- Project Definition — root configuration that ties a project together
Role-Based Guides
SpecScore is designed for every role on a product team:
| Role | Guide |
|---|---|
| Developers | docs/for/developers.md |
| Product Owners | docs/for/product-owners.md |
| QA Engineers | docs/for/qas.md |
| Business Analysts | docs/for/business-analysts.md |
| Project Managers | docs/for/project-managers.md |
| Architects | docs/for/architects.md |
Ecosystem
SpecScore is the foundation layer of a three-tool stack:
| Tool | Role |
|---|---|
| SpecScore | Open specification format — the standard itself |
| Rehearse | Validates and tests SpecScore specs automatically |
| Synchestra | Orchestrates multi-agent execution of SpecScore specs |
Use SpecScore standalone with any tool, or pair it with Rehearse and Synchestra for a full spec-driven development lifecycle.
See docs/ecosystem.md for details.
Contributing
Contributions are welcome. See CONTRIBUTING.md to get started.
License
Apache License 2.0. See LICENSE for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
specscore
command
|
|
|
internal
|
|
|
pkg
|
|
|
exitcode
Package exitcode defines the shared exit code constants and error type used by all SpecScore CLI commands and library consumers.
|
Package exitcode defines the shared exit code constants and error type used by all SpecScore CLI commands and library consumers. |
|
feature
Package feature provides feature discovery, traversal, metadata, dependency resolution, and scaffolding.
|
Package feature provides feature discovery, traversal, metadata, dependency resolution, and scaffolding. |
|
gitremote
Package gitremote parses git remote URLs into their owner / repo / host components.
|
Package gitremote parses git remote URLs into their owner / repo / host components. |
|
task
Package task defines the canonical task types, status enum, and related structures used by all SpecScore-based coordination tools.
|
Package task defines the canonical task types, status enum, and related structures used by all SpecScore-based coordination tools. |