Docs
Documentation
Everything you need to read, write, and check SLCR documents.
Overview
- OverviewWhat SLCR is, the problems it addresses, and how specifications, slices, and validators fit together.
- Use casesWhat SLCR is used for, from building with coding agents to catching drift in CI, and when it isn't a good fit.
- FAQAnswers to common questions about SLCR: whether it's ready, what it costs, which languages and platforms it supports, and how to use it with coding agents.
Getting started
- InstallationInstall the
slcrCLI and the agent skill, keep them up to date, and install them in CI. - QuickstartSet up SLCR in an existing project with a coding agent, and see which requirements your code already meets.
- Tutorial: write a small SLCR specificationLearn SLCR by writing a small specification, checking it with validators, and seeing requirements go from unsatisfied to satisfied.
Concepts
- SpecificationsHow SLCR stores requirements as a graph, the four kinds of node, permanent IDs, and how specs make up a project.
- Links and satisfactionHow requirements connect to each other, and how those links decide whether each requirement is satisfied.
- SlicesWhat a slice contains, what it leaves out, and how slicing affects the way a spec is written.
- ValidatorsHow acceptance criteria, validators, and tools turn requirements into checks that pass or fail, and the difference between vetting and checking.
Guides
- Writing requirementsHow to write requirements that are checkable and slice well: one testable statement each, the right modality, explicit links, and a sliceable structure.
- Migrating existing documentsConvert an existing requirements document to SLCR with a coding agent, then review and verify the result.
- Add a validator toolDeclare a tool in a project, write validators for it, and keep its descriptor up to date.
- Run SLCR in CICheck a project's specifications, rendering, and validators on every change, with the SLCR GitHub Action or any CI system.
- Troubleshoot
slcr checkWhat eachslcr checkfailure means and how to fix it: vetting errors, red validators, unsatisfied or unknown requirements, and CI-only failures.
Reference
- SpecificationThe normative definition of the SLCR specification file format: files, IDs, sections, requirements, acceptance criteria, links, and vet findings.
- Project manifestThe normative definition of SLCR.toml, the file that marks a project's root and declares its specifications and tools.
- Validator filesThe normative definition of validator files, which tie requirements to the tools that check them.
- Tool descriptorsThe normative definition of tool descriptors, which describe how SLCR runs the tools validators use.
- CLIEvery
slcrcommand, frominitandchecktosliceandrender, with its arguments, options, and exit codes.