From the course: Learn API Documentation with JSON and XML
Unlock the full course today
Join today to access over 22,600 courses taught by industry experts or purchase this course individually.
Tools for structured data documentation
From the course: Learn API Documentation with JSON and XML
Tools for structured data documentation
- [Instructor] Let's take a look at some tools that you can use for documenting JSON and XML. You can use a word processor like Microsoft Word, but most developers prefer web-based documentation. Developers won't read the documentation from start to finish. They usually just want a specific piece of information. Web-based documentation is easier to jump around in, which means that it's easier for developers to find the information they're looking for. At a minimum, here are the features that you need for API documentation. Tables to describe the JSON and/or XML, links to other parts of the documentation and Monospace font for when you include sample requests and responses. Word processors are the most common tool for any kind of document. Examples are Microsoft Word, Google Docs and Apple Pages. Typically, you'd use a word processor to generate a PDF file which you would then put up on the web. Word processors allow you to create sophisticated formatting and can do some nice tracking…
Practice while you learn with exercise files
Download the files the instructor uses to teach the course. Follow along and learn by watching, listening and practicing.