We hope you find our online library to be informative, relevant, and helpful to your work.
In uncertain times, everyone needs to justify their value. Technical communication excellence (TCE) delivers value in many tangible ways. This article explains them.
This list of potential deliverables applies to any developer-to-developer documentation suite. This includes APIs, SDKs, platforms, frameworks, and other types of software development platforms. For simplicity, we’ll refer to this collection of technologies as APIs, because they all have similar documentation needs.
The quality of API documentation is a key differentiator for API providers, and directly impacts both API adoption and satisfaction. To be competitive, your API documentation has to be really good. But what does that really mean? This article explains.
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, this 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.
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?
