The following example shows how to document an API. This example is taken from the Bing Ads Content API, which is a RESTful API. RESTful API Example – Get Single Item This section describes the type of API and some details about the type of operations it performs. The Bing Ads Content API is a […]
Kai raised an interesting point about which skill (writing/technical) takes longer to master. Knowing how to structure and present information to users? Or knowing how to use a product or application? That got me thinking. If you want to make money as a technical writer, which area should you focus on? Sharpen your writing skills or deepen your technical knowledge, for example, learning how to document an API?
One of the threads on LinkedIn is how to write technical documentation for APIs. It’s been many years since I’ve documented an API (Java & Oracle) so if you have any thoughts on the best way to do this, then please jump in. An application programming interface (API) is an interface implemented by a software […]