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 […]

12 Steps To Getting Started as a Technical Writer

Most people think it’s difficult start a career as a technical writer. I used to think the same in my early 20s when I started in IT. In retrospect, I should have made more efforts to establish myself as a consultant earlier; the benefits certainly outweigh the downsides. As luck would have it, I was […]

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. […]

What’s the Best Font for Web Writing?

When I started in tech docs, Times New Roman was THE font for printed manuals. There was no ifs, buts, or maybes about this. Times New Roman. Size 11. Since then other more trendy fonts have come onto the market. Trends in font styles come and go. While fonts in printed publications are one thing, […]

Using Google Plus to Write Technical Documents

Maeve asks on LinkedIn how we can use Google Wave to write technical documents. Well, the first consideration is that Google Wave is not designed as a tech authoring tool but for collaboration and ‘almost’ real-time information exchange. Saying that, it does offer many benefits if you need to plan/coordinate/review documents in a networked environment. Here are some ideas.

7 way to come up with fresh content for your blog three times a week

Denise Wakeman asks, “How am I going to come up with fresh content for my blog three times a week?” She lists some excellent ideas designed to help save you time and stimulate some new ideas. Here are some others you might want to consider.

How I Set Priorities

Ross Kimbarovsky asks: “How do you decide what to do next? Should you write a blog post? Answer emails in your inbox? Make several sales calls? Spend time on Twitter? Or should you call a team meeting to discuss a customer problem? Ross adds that successful people are successful in part “because they are good […]

[How To] Find a Technical Writing Niche

Tom Peters says, “the value of services will continue to fall” and that the only way to survive is to differentiate yourself from the competition. Is this true? How do you as a technical writer make yourself stand out from the crowd? If you don’t, what impact could this have on your career? How to […]

How Technical Writers Can Move Further Up The Food Chain

Do you feel loved? Many technical writers feel unloved. They feel they don’t get the respect they deserve. I hear this on LinkedIn and Facebook: “people don’t respect the work I do.” Well, if that’s the case, here are a few ways to get more respect and move into a more rewarding career.

How Advertising in User Guides Could Work

Putting advertising in user guides may seem rather flaky at first, but it could work. Here’s why. Life is full of taboos. Things you should and shouldn’t do. One of my ‘pet projects’ is to connect the lines between Sales and Technical Documentation. To me, they both serve the same purpose. Serve the customer. While they both start at different points, the end goal is the same. Unfortunately, these two departments rarely work together. Let’s take a look at how we can fix this.