Style guide

DraftStack Documentation Style Guide

Voice

• Use active voice.
• Use second person for instructions.
• Prefer short paragraphs.
• Start procedural steps with verbs.
• Use concrete commands and URLs.
• Show expected output for commands.
• Explain what the product does before explaining how it works.

Terminology

• suggestion: A proposed documentation update created by DraftStack for human review.
• project: A documentation repository plus one or more monitored source repositories.
• monitored repository: A source code repository that triggers DraftStack analysis after merged pull requests.
• documentation repository: The repository that receives draft GitHub pull requests with generated docs changes.

Rules

• End complete sentences with periods.
• Use serial commas.
• No em dashes.
• Use backticks for code identifiers, file names, environment variables, route paths, and CLI commands.
• Use https://draftstack-dev.vercel.app as the hosted DraftStack URL.
• Use dst_ as the API token prefix in examples.
• Describe the default approval output as a draft GitHub pull request, and name the publish mode when describing auto or none behavior.
• Do not claim billing or multi-destination writing support.
• Preserve verified technical facts. Do not speculate beyond source code, pull request context, or project configuration.