Skip to content
DV
  • All Posts
  • Articles
  • Notes
  • Reads

Tag: writing

read
August 16, 2020
A Brief Introduction to Technical Writing by Stephanie Morillo

They’re scanning the page for specific words, phrases, or code snippets that will point them in the right direction.

 

the developer isn’t visiting the docs to admire the writing capabilities of the person who wrote the doc; they’re visiting the docs to help them do something.

 

While copywriting is used to persuade a user to take a certain action, technical writing exists to support the user and remove barriers to getting something done. Good technical writing is hard because writers must get straight to the point without losing or confusing readers. It requires a familiarity with the subject matter, the ability to listen and observe, and a deep understanding of the reader.

Great short intro to tech writing. This is an area I value immensely, and yet constantly deprioritize. So much thought and care goes into good tech writing that it’s almost unnoticeable when done well; you just feel more effective.

Leave a comment

Post navigation

Dmitri Vassilenko

  • githubGitHub icon
  • twitterTwitter icon

Just another Unremarkable White Dude in Tech.

Keeping notes on things I learn. Writing to think. It’s a mess, but it’s my mess.

Tags

a11y abuse agile architecture code decolonization design diversity epigenetics games health leadership open-source org philosophy podcast privacy racism remote-work sleep somatics systems tech therapy trauma work writing
This site is powered by WordPress and styled with the Autonomie theme