docs-write

Write documentation by applying a user-first approach: use bold for UI elements, backticks for code and variables, descriptive links, American spelling with serial commas, and consistent heading structure. Run Prettier after editing to enforce formatting rules automatically.

Structure docs with clear headings, numbered steps, and descriptive language. Use bold for UI elements, backticks for code references, and ensure each step builds logically. Prettier formatting maintains consistency across the documentation set.

Use Prettier to automatically enforce consistent formatting after editing. It applies standardized spacing, indentation, and line breaks across Markdown and MDX files, reducing manual formatting overhead and ensuring uniform style compliance.

Yes, this approach works with both Markdown and MDX formats. Apply the same style guide rules—bold UI elements, descriptive links, code backticks, American spelling—and run Prettier on both file types to maintain consistent formatting and terminology.

Use backticks for code snippets and variable names, bold for UI element references, descriptive link text, American spelling with serial commas, and logical heading hierarchy. These conventions improve readability and ensure documentation adheres to style guide standards.

Consistent linking and styling improve user navigation, reduce confusion, and establish credibility. Descriptive links help users understand destinations before clicking, while standardized formatting (bold UI elements, backticks for code) makes technical content scannable and accessible.