You may also visit the Technical Writing page.
Technical writing is the process of researching and writing about specialized topics in a way that is clear to the intended audience. Technical writers work closely with your subject matter experts (SMEs) to learn the details of your products, policies, and procedures. They take the time to understand you and your audience to eliminate the … Read more
The most visible documents that technical writers produce are product manuals or guides that accompany products to customers and instruct them on product assembly and usage. Online help consisting of a series of short instructional blurbs incorporated into the product itself is also common. Some technical writers never write any product documentation meant for external … Read more
The objective of a disaster recovery (DR) plan is to ensure that an organization can respond to a disaster or other emergency that affects information systems – and minimize the effect on business operations. Below is a sample template to produce a basic disaster recovery plan. The following are the suggested steps as found in the DR template. … Read more
1. Know your audience Written communications are most effective when they are targeted and personal. Build your writing around the needs and interests of the user of your technology product. Most technical documents – blog articles, white papers, manuals, reports, brochures are written for many readers, not just an individual. You may not know the … Read more
A technical white paper is a document that describes how a technology or product solves a particular problem. A good white paper is informative and is written to give readers an idea about the advantages of a product or technology. Writing a whitepaper requires deep understanding of a product’s technology as well as its application … Read more
In my initial days of working as a technical writer, I was advised not to include screenshots of the proprietary software anywhere in documentation. The rationale was that the images could land into wrong hands and competitors would be able to scoop up the features we were adding to the software. That was 2004. Today, practically … Read more