Installation Guide Checklist: Sample Template For Technical Writers

In the introduction section, identity the software you are about to install, steps to prepare for installation, running installation scripts, and post-installation tasks after the installation script has completed. In general, your installation guide will include most of the following: Introduction Choose the Installation Type Concepts Setup Pre-Installation Requirements Pre-Installation Checklist Installation and Configuring Procedure […]

Sample Guidelines for Writing Online Help

If you’re looking for guidelines to write your online help documentation, then use this checklist to get started.

21 Words That Make Technical Writers Look Dumb

We both know that a Microsoft Exchange Server doesn’t have feelings, hopes and desires. But when we write technical documents, these type of human feelings can creep in. You need to be careful when writing user guides, design documents, and specifications as these false words give the wrong impression and undermine the quality of your material.

9 Ways To Peer Review Technical Documents

I’ve always had mixed feelings about peer reviews. What they’re done right, we all learn but like Lesson Learned review can easily degenerate into bitching sessions if not managed correctly.

How To Make Friday Your Busiest Day

lance-armstong-getting-things-done Friday is my busiest day. Most folks power down and go into weekend mode. Not here! Ask yourself, ‘why do I go down a gear on Friday?’, ‘How does this benefit my career?’ Ok, let’s be honest. We do this because others do it. Right? This is a high-risk way to manage your career. You’re letting others determine how you behave. And it damages your career in many, many ways. Here’s an alternative approach.

How To Write Technical Documentation For REST/Web APIs

Why write API reference documentation? If your company develops APIs, then you can provide reference documentation for each API available with the product. The API documentation should describe the common components used by each of the APIs for iOS, Android, and other platforms. Essentially, the API reference documentation explains the data structures available through the APIs. […]

How To Manage Negative Comments on your Blog

I need your advice. Someone has left a fairly negative comment on my blog. What should I do? Approve or Delete?

Put Your Words on a Diet

Goethe once wrote to a friend, “If I had more time, I’d have sent you a shorter letter.” Here’s why.

How To Mind Your Grammar On The Web

Ben Parr (Mashable) asks: “Say your project manager comes to you with his proposal that will be going out to investors, business partners, and potential clients. Then you find that your manager has used “4” instead of “four”, “r” instead of “are”, and abbreviations such as lol, atm, and idk. How would you react? “

Dow Jones Rules for Social Media

The Wall Street Journal writers were given a newly compiled list of rules for “professional conduct,” which included a guide for use of online outlets, noting cautions for activities on social networking sites. The memo says that staffers should consult their editor before “connecting” to or “friending” any reporting contacts who may need to be treated as confidential sources, and business and pleasure should not be mixed on services like Twitter. The revised code of conduct also includes details about offline friendships, freelance work and public speaking.