Technical Communication with a Purpose

The Ideal API Reference Manual

An application programming interface (API) is a set of defined interfaces for a specific software application, such as desktop publishing software, a database, or an accounting package. An API allows access to that application through a program instead of through a user interface.

Quick and Easy Document Specifications

Technical documents have a purpose. If you don’t understand the purpose of a document before you start writing it, you may deliver the wrong document. A document specification (doc spec) should define your document before you have a chance to get into trouble.

Working with a Professional Writer to Create Technical Documentation

You have a new software tool project, and you know the finished product is going to need good documentation. What does that mean, and what’s it going to take? When should you get started working on the documentation, and how much of your team’s time will be taken up by it?

Documentation as a Competitive Advantage – Hardware Products

You’re working on the release of your new software, hardware, widget, or other technical masterpiece, and realize that you need to include documentation in the package to get your customers started using your product. The question is, what role do you want the docs to play?

Documentation as a Competitive Advantage – Software Products

You’re working on the release of your new software, hardware, widget, or other technical masterpiece, and realize that you need to include some documentation in the package to get your customers started using your product. The question is, what role do you want the docs to play?

Estimating Software Documentation Projects 101

Oh my gosh, my meeting is in 30 minutes and I need a doc budget! The purpose of this article is to give you enough information about budgeting software documentation projects that you can quickly come up with a back-of-the-envelope estimate of the time and money required…

×

Paul Gustafson is Expert Support's new president. Learn more