Posts of interest to technical writers.
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 »
Many people dream of working remotely from an island paradise. One of our star tech writers, Tony Bove, has been living this dream for years. This article shares his insights and thoughts about the WFH experience to help those who may be experiencing this way of working for the first time.
Lessons from a “Work from Home” Expert 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 »
Excessive typing can cause hand pain and/or numbness. Our team found a simple, inexpensive solution that’s worked for several of our writers and editors.
Got Hand Pain? Try This! 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 »
Do you want to land a job writing API documentation? Here’s how to get started.
How to Get Your First API Documentation Job Read More »
I signed up for the writing tips from WordRake a while ago. Even though the tips are written by a lawyer, they apply to human beings too. 🙂 Useful and entertaining. You can sign up to get the weekly tips via email at http://www.wordrake.com/writing-tips/.
Check out WordRake 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 »