Templates in this guide
Each template’s contract, as configured. Studio names any required input still missing before a run starts. The word range is checked by the editor on Standard and Premium, and the Quality Gate records which required sections it found at every tier; a shortfall in either is recorded in the document’s quality report and does not block publication on its own.API Documentation Template
API Documentation Template
Required sections: Introduction; Authentication; Endpoints; Error handling; Code examples.
Technical Documentation Generator
Technical Documentation Generator
Required sections: Overview; Getting started; Core concepts; Implementation; Code examples; Testing; Troubleshooting.
Product Requirements Document
Product Requirements Document
Required sections: Product context; Problem statement; Goals and non goals; Target users; Functional requirements; Non functional requirements; User stories; Acceptance criteria; Dependencies; Risks and open questions; Success metrics; Rollout plan.
Inputs that change the result
- The specification itself. Upload an OpenAPI file, schema, or design document. Without one, endpoint names and parameters in the draft are illustrative and must be replaced.
- Audience. State whether the reader is integrating, operating, or approving the system.
Limits
- Code samples and request examples are not executed or tested.
- In the SaaS & Tech vertical, the advisory
saas.api_contractsverifier checks that each HTTP status code carries its own standard reason phrase. It does not check any part of the documentation against your running service. - Validate every instruction before implementation or deployment.
SaaS & Tech
Rules and verifiers for software documentation.
Generation Workspace
Attach source files to a generation.