Skip to content
DV
  • Articles
  • Journal
  • Micro
  • Links
  • Now

Tag: writing

link

A Brief Introduction to Technical Writing

User Avatar of Dmitri Vassilenko Dmitri Vassilenko
· August 16, 2020 · 1 minute to read

A Brief Introduction to Technical Writing:

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
User Avatar

Dmitri Vassilenko

  • githubGitHub
  • twitterTwitter
  • mastodonMastodon

Backend distributed systems developer, living in southern Ontario, Canada. Occasional rock-climber, frequent video-gamer. Jack of no trades, master also of none.

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

← 🕸💍 →

You can use an RSS feed reader rss/atom feed icon to be notified of new posts. Just add the URL of any page into it and it should show the available feeds. Subscribe to a category (top menu bar) by using its URL.


If you'd like to receive my posts by email, please fill out the form below.

Lists*

Loading

Misc

  • Site changelog
This site is powered by WordPress and styled with the Autonomie theme