Tech writing

 


Technical Genres – Writing with Purpose



Not all technical documents are created equal. Each serves a unique function—and your writing should adapt accordingly.



Common Genres You’ll Encounter:



  • User Guides: Help users accomplish specific tasks step-by-step. Think of IKEA manuals—but clearer.
  • API Documentation: Written for developers. It includes parameters, functions, endpoints, and examples.
  • Knowledge Base Articles: Concise, searchable answers to common questions or issues.
  • White Papers: Long-form, persuasive documents used in B2B settings to explain problems and propose solutions.
  • SOPs (Standard Operating Procedures): Detailed, repeatable instructions for internal processes.



Tip: Always match the tone and depth to your audience. Developers and end-users don’t need the same kind of detail or format.


Comments

Popular posts from this blog

Career

Looks matter

Welcome to my blog