How Much Programming Do You Need to Know to Write API Documentation?
By Samuel Wright Jobs in the developer documentation space, such as API reference material, quick start guides, and programming examples, are on the increase. Which is all very well for writers who...
View ArticleAPI Writing: More than Making API Docs Pretty
By Cherie Woo “Here’s my technical spec—all you need to do is format it,” an engineer once told me. “Make it pretty,” she added. When I began my API technical writing career, I always took such...
View ArticleWhat Tools Do You Use to Produce API Documentation?
By Anita Andrew | Senior Member Over the years the IT industry has seen a significant growth in APIs that are available as free and paid services. Clearly, it is imperative to have good API...
View ArticleHow Does API Documentation Differ from GUI Documentation?
By Cyrus R. Kirby There are two sides to technology that a content developer supports. The side that most people are familiar with is an application’s interface. Often referred to as the “GUI”...
View ArticleREST API for Dummies. What Does the Developer Expect From Your REST API...
By Dmitriy Mironov One of the most common types of APIs that technical communicators document are REST APIs. REST APIs facilitate the interaction of client-server technology: a client sends a request...
View ArticleWhat Is API Documentation?
By Scot Marvin | Member I’ve been writing API documentation for 15 years. During that time, I’ve seen a rise in API offerings. Companies are producing platforms that they hope others will plug into,...
View ArticleLessons Learned as a Novice API Writer
By Mary Linderman In this article, I will share some of the lessons that I have learned working as an API writer for the past two years. I stumbled into this role by accident when my employer decided...
View ArticleWhat Factors Contribute to Good API Documentation?
By Lois Patterson You may be familiar with what API documentation is and understand the organization of reference information into logical arrangements. But what makes API documentation good or bad?...
View ArticleHow to Write Helpful Code Samples
By Sarah Maddox | Member As technical writers, we are trained to put ourselves into the position of the reader. In the case of API technical writing, the readers are developers looking to use our APIs...
View ArticleHow Do You Break into API Documentation?
By Mary Connor | Member The Market Large numbers of us broke into technical writing by documenting software that runs on personal computers. Over the years, we have watched sales of those machines and...
View Article
More Pages to Explore .....