Audience
Primary readers are partner engineers integrating Suki APIs and SDKs into healthcare applications. They know REST, JSON, and OAuth/JWT basics. Prefer task-ready guidance over explaining those primitives unless the page is explicitly introductory.Terminology
Use published product names and casing from the style guide and Vale:- Form filling, Form filling SDK, Form filling API(s) in body prose; Form Filling / Form Filling SDK / Form Filling API(s) in Card / Tab / nav / frontmatter titles
- Mid-sentence ambient as a common adjective (
ambient session); Ambient as product list / sentence-start / UI chrome; Ambient API(s) as the product name - Dictation, Patient Summary, Partner ID, Partner Token, Suki Token, WebSocket
- Keep code identifiers exact:
InitOptions,SukiAuthManager,PlatformClient,DictationClient
Content types
Identify the page type before editing. Prefer one type per page:
If a how-to needs a concept, link to the concept page instead of restating it.
Style
- Sentence case for H2/H3; no trailing
?on How/What/Why headings - Oxford comma; no em dashes; active voice; present tense
- Sentence case for Next steps and body link text; preserve protected product tokens
- Do not restate the title in the first sentence
- Do not invent product behavior; ask when ground truth is missing
- Do only what was asked; no drive-by refactors
Documentation access
Published docs serve Markdown at the same path with.md appended. Prefer those when fetching live pages:
Example: https://developer.suki.ai/documentation/get-started/overview.md
Agent indexes and skills:
https://developer.suki.ai/llms.txt(curated page index)https://developer.suki.ai/.well-known/agent-skills/index.jsonhttps://developer.suki.ai/mcp