Posts of interest to tech pubs managers.
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 post explains.
Why You Need One, and What It Is: The Ideal API Reference Read More »
Whether you’re playing poker or creating developer documentation, it’s always better to have an ideal hand. In poker, the ideal hand is a royal flush. In developer documentation, there’s also an ideal hand.
Poker and Developer Docs Read More »
Use this article as a checklist when creating documentation for software developers, and support every crucial stage of the developer experience.
The Ideal Documentation Suite for Software Developers Read More »
When interviewing technical writers, make sure you’re evaluating how well they’ll write at least as much, if not more, than the tool you want them to use.
It’s Not About the Tool Read More »
Professions requiring long hours of solitude can cause problems when workers are unaware of the emotional impact of such work.
Emotional Amplification Read More »
Effective technical writers interact with experts enough to gain the knowledge required to explain the technology, but they never overdo it.
The Art of Balance – Optimizing Communications with SMEs Read More »
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?
How to Work with a Tech Writer for the Best Results Read More »
Developmental editing is a highly beneficial part of creating a quality document, and can include evaluating the overall organization, identifying possible missing material, and identifying ways to improve the general quality of the writing. This article discusses where developmental editing fits into the scheme of technical writing.
Developmental Editing Read More »
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, and here are some ideas about doc managers…
Did you know you can rent a doc manager? Read More »
In Silicon Valley companies (actually in nearly all technology companies) people play “Chicken” with schedules. Huh, you say?
Schedule Chicken: Knowing When to Commit to the Impossible Read More »