DEV Community

loading...

Technical Writing with DEV

Alpha Olomi
A software engineer aimed at helping other using software technologies.
・1 min read

Technical writing

The development world has dramatically evolved drastically. An important implication of the rapid stride in technology has led to the emergence of demand for technical writers. In other words, technical writers do technical writing.

Introduction

Technical Writing is writing or drafting technical communication used in technical and occupational fields, such as computer hardware and software, engineering,

Technical writing is a very good skill for

  1. Developers help in writing great documentation.
  2. Security analysts/researcher - help in writing well informative reports.
  3. Basically almost any one in the tech community.

You can find some helpful resources here to help you get started https://github.com/BolajiAyodeji/awesome-technical-writing

Technical documents

Although we can focus technical writing on writing software documentation, others could be focusing on scientific writing. Technical writing covers many genres and writing styles, depending on the information and audience.
Some examples of technical documentation include:

  • Instructions and procedures
  • Proposals.
  • Technical reports
  • API guides
  • Technical/Engineering Blogs
  • And many more

About DEV

From DEV about page

DEV is a community of software developers getting together to help one another out. The software industry relies on collaboration and networked learning. We provide a place for that to happen. DEV is open source,

Link https://dev.to/

This is obviously not the end, There is alot to talk about technical writing,

Discussion (0)