Technical Content

Make it easy to understand

Writing coach

The issue with most technical content is that it needs to be understandable to your audience. It is often difficult for a technical person to realize how how little background information or understanding of basic terms the reader may have. Without providing a foundation, you make it difficult for them to easily comprehend the information.

Because I am a software engineer by training, I understand technical subjects. As an editor, I distill your information in a way that is approachable to the reader. Maybe your target audience is in the same field as your topic, so they have the technical capabilities to understand your topic. But say that you are applying this technology to a new field, such as the aviation industry. You must provide the necessary material for them to grasp the new situation.

Identifying what your audience knows and what they need explained is critical to well-written technical  content. Also, the tone of the piece should be defined. Does it need to follow APA, MLA, or Chicago/Turabian Citation Styles?

content

  • Personal blogs
  • Public blogs – Medium, Reddit, Hacker News
  • White papers
  • Books
  • Magazine articles
  • How-to

topics

  • Agile product development
  • Product manaagement
  • Cryptocurrency and blockchain
  • Software engineering development
 
We had a very short deadline to revise a 7 page open letter for an opensource project. Samantha responded quickly, wasted no time asking important questions, and had the work done so quick that we were rather surprised. The quality of her work did not suffer either.
— Upwork client on a cryptocurrency paper