Our aim with Expert Support’s online library is to share some knowledge and expertise with you that we have gleaned from over two decades in the business of technical communication. We hope this sparks conversations with you and encourages you to join our network.
Read these online or download a pdf for offline reading.
Money is tight these days, especially in the software business. When money gets tight, budgets get cut. Unfortunately, sometimes the wrong line items get cut. Often, far too often, software companies cut the documentation budget when they shouldn’t.
What it is… As technical writers, we are often called upon to do a developmental edit on existing documentation. As a web search quickly reveals, “developmental edit” means different things to different people.
Do you need a documentation manager, but just for four weeks out of the year? You aren’t alone. Documentation is critical to the task of presenting products to customers, but small companies can’t afford to have a full-time documentation expert on staff.
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?
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?
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.
Definitions, suggestions, and examples to help you create an excellent API reference manual…
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.
In Silicon Valley companies (actually in nearly all technology companies) people play “Chicken” with schedules. Huh, you say?
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?