Instruction file imported from superdurable/dex (.cursor/rules/docs-writing.mdc). Copyright stays with the author.

Documentation Voice

Write docs in plain, direct English. Sound like an engineer explaining the system to a peer — not like marketing copy or a chatbot summary.

Chinese (zh-Hans) pages should read the same way in 简体中文: short sentences, concrete terms, no translationese. See .cursor/rules/docs-i18n.mdc for locale file layout.

• Prefer short sentences and concrete nouns. Cut filler ("In today's world", "It's important to note", "This powerful platform").
• State the problem, then the mechanism. Do not stack synonyms or repeat the same idea in three forms.
• Use Dex terms exactly: Flow, Step, Attribute, Channel, RPC, Timer.
• Do not wrap API names, method names, types, or identifiers in inline backticks in prose. Use bold instead (for example WaitFor, StepDecision, InvokeRPC). Fenced code blocks and bash / text fences are exempt.
• make docs-prose-check enforces this. Hooks run the same check on staged docs when you commit.
• Diagrams and examples should carry structure; prose should not over-explain what the diagram already shows.
• Avoid bullet lists when a paragraph reads better. Avoid numbered lists unless order matters.