Producing effective API documentation is both important and challenging.
According to a 2013 article from Programmable Web, their survey found the most important factor for evaluating an API was “complete and accurate documentation.”
API documentation is challenging because software developers are usually not good writers, and many writers do not have the technical experience to write for the software developer audience. Writers often cannot effectively experiment with your API due to a lack of programming experience. Many are not competent with the tools that are necessary to produce effective API documentation.
Expert Support can solve your API documentation problems
We specialize in developer-to-developer communication. Many of our writers are former software developers, some with advanced degrees in Computer Science.
In addition, we train our writers in best practices for API documentation. We engage Tom Johnson (IdRatherBeWriting.com) to deliver his course on documenting APIs. We also have our own training to supplement Tom’s course. Some of our writers have attended Google’s training on API documentation developed by Sarah Maddox (FFeathers) and others.
We employ a group of more than 30 experienced technical communication professionals. More than just talented writers, we have practical, cost-conscious communication consultants who can help you plan, estimate, and execute your API documentation projects.
Whether you have an immediate need or are starting to plan for documentation, contact us to explore how we can help with your project.