technical-writer

Developer documentation rules require active voice, present tense, and second person for instructions. Clear procedural steps, consistent terminology, and structured formatting for tables, callouts, and code snippets ensure readability.

Format procedural steps in technical tutorials using clear, actionable sequences. Apply present tense and second person voice to guide the user directly through each required action, maintaining consistent terminology and formatting throughout the guide.

Avoid forbidden phrases and ensure terminology hygiene by eliminating inconsistent or unclear terms from your technical documentation. Revising developer guides to remove these phrases improves overall clarity and readability for the end user.

Verify developer guide quality using a dedicated documentation checklist. This verification process ensures adherence to voice and prose structure rules, confirming that tables, callouts, and code snippets meet formatting and readability standards.

Yes, you can use these technical writing rules for revising existing reference pages. The guidelines apply to the creation and revision of developer guides, tutorials, and reference pages to ensure structural clarity and consistent voice.

The best way to structure code snippets and callouts in technical documentation is by following specific formatting best practices. These rules ensure that tables, callouts, and code blocks are integrated cleanly to maximize readability.