writing-quality

Improve documentation clarity by applying structured writing standards that enforce short sentences, active voice, present tense, and concrete terms across user guides and developer docs.

Draft API references using standards that enforce technical accuracy, including runnable examples, correct versioning guidance, valid code syntax, and progressive disclosure tailored for specific audiences.

Ensure developer documentation is complete by applying a structured checklist that verifies technical accuracy, valid snippet syntax, correct versions, and progressive navigable structure.

Yes, these structured writing standards apply to internal design documents, user guides, and developer documentation, ensuring clarity, accuracy, and audience awareness across all technical content.

Review technical documentation for audience awareness by applying tailored guidance that distinguishes between end users, contributors, and API references, ensuring content suits each reader's context.

Use progressive disclosure in technical writing when structuring complex developer documentation or user guides to present information navigably, ensuring clarity without overwhelming the audience upfront.