Style guide
/authoring/scribe/style-guide
PreviewScribe previewscribe
The Documentation Style Guide sets the tone Scribe uses when it generates a project's documentation. It is scoped to a project only — "Choose a project to set the tone Scribe uses when it generates its documentation." — and the choice is injected into every generation prompt the authoring service builds for that project.
Tone preset
Four cards, the current one tagged Current:
| Preset | Reads |
|---|---|
| Technical (default) | "Precise, formal, assumes developer audience. Avoids colloquialisms." |
| Friendly | Conversational and welcoming |
| Concise | Short sentences, no preamble |
| Enterprise | Formal, complete, compliance-minded |
Clicking a card saves it at once — "Tone saved." — and rolls back if the save fails ("Could not reach the authoring service."). Until you choose, "Using the default Technical tone. Choose a preset to set it for this project."
The style guide is stored in Spire alongside the project's terminology and custom guidance (see the Spire API); only the tone preset has a control on this page today.