Technical Writing: How To Write Api Software Documentation

A framework for writing software documentation for an API as a technical writer, using Postman or Swagger UI

What you'll learn
What is API?
What is API documentation?
Which steps to follow to create API documentation?
How to use Swagger UI to write API documentation?
How to use Postman to check the functionality provided with an API
How to put your API documentation together in a GitHub wiki page!

Requirements
No programming knowledge is required

Description
Are you a technical writer who must write API software documentation? Do you wonder what you need to prepare and deliver to have high-quality API documentation and do not know where to start? If yes, then this course is for you!JPDocu School of Technical Writing is a training company passionate about technical writing, software documentation, APIs documentation, information architecture, and DITA XML, and helping our students get started and quickly advance in their Technical Writer career.Our Technical Writing courses are taught as a part of the University courses on Technical Communications at several universities in Europe, as well as a part of the onboarding for new technical writers for many of the best software development companies.We shape the next generation of technical writers and information developers, by providing them with simple-to-follow and practical, hands-on experiences with technical writing.At JPDocu School of Technical Writing, we believe that technical writing is and should stay a simple task. Simple like in "easy to do"! That's why we do our best to explain API and API documentation in simple terms, making it simple and easy for you to follow!API stands for Application Programming Interface. An interface is a software abstraction, which allows two software applications to communicate with each other seamlessly. There are two roles you need to consider when you write documentation about an API:The role of the developer who created the API. This developer needs to provide information about the way the API is supposed to work; what requests can it receive and what responses does is provide. The role of the developer who uses the API. This developer needs to read through the API documentation to understand the ways to connect to the API, the requests that he or she can send to the API, and the responses that the API shall return for these requests. In this course, you will learn:What is API and API documentation - explained in a way so that you can understand. No special programming knowledge is required! The steps you need to follow to prepare and provide documentation about your API - our unique framework to make sure you have steps to follow while preparing the API documentation.How to use Swagger UI to write and generate API documentation automatically. How to use Postman to check the functionality provided with an API, and How to put it all together on a GitHub wiki page!Try it now, and see how easy it is to write API documentation, once you know which are the basic steps to follow!

Who this course is for:
Technical Writers,Information Developers,Software Developers,UX Writers