Learn API Technical Writing: JSON and XML for Writers

4.5 (3336)
MOOC
Payment
Learning paid
Language
English
Duration
1.5 hour coourse
Course by Udemy
What will you learn?
Read and understand structured data in JSON and XML formats.
Write documentation for JSON and XML files, for API documentation or other types of documentation.
Understand how to edit JSON and XML for tools that generate documentation.
About the course

This is the first in a series of courses for technical writers who want to learn how to write API documentation. This course teaches how to document structured data, focusing on the two most popular structured data formats: JSON and XML. If you are new to API documentation, this is a great place to start. No programming experience is required, but technical writers with programming experience who want to know more about structured data will still find it useful.

What are APIs?

APIs (Application Program Interfaces) define how software systems talk to each other, and API documentation is a rapidly growing field. There is a strong need for writers who can understand APIs and explain them so that software developers can understand how to use them. API writers get to be in on the cutting edge of technology in high-paying positions.

What is in This Course?

By the end of the course, you will understand what APIs are, why they are important, and how to read and document structured data. In this course you'll find:

  • Eight videos that:
    • Provide background information on APIs and structured data
    • Break down sample JSON and XML files to show you how they work
    • Show real-time, narrated writing of JSON and XML documentation
  • Four hands-on exercises to lead you through building and documenting JSON and XML files
  • Two text-based lectures about useful software tools
  • Five short quizzes to keep you on your toes
  • PowerPoint presentations as a resource for every video lecture

The course takes approximately 2.5 hours to complete, depending on how fast you are with the exercises.

Program
Introduction
Understand what structured data is and why it is important.
Overview

Covers:

  • Teacher's background and credentials
  • What are APIs?
  • Why is API documentation important?
  • JSON, XML, and how they compare
  • Class overview
Data Types and Structured Data
Covers:
  • Data types
  • Boolean values
  • Structured data
Identify Types of Data
Please answer the following questions about data types.
Tools for Writing JSON and XML
For this class, you'll be creating JSON and XML files. This lecture recommends some tools you can use.
JSON
Understand and document structured data files in the JSON format
What is JSON and How Does It Work?
Covers:
  • The history of JSON
  • Basic data types
  • Arrays
  • Objects
  • Nesting
  • Indentation
On completion, students will be able to read and understand JSON files.Note that this for this (and all video lectures), the PowerPoint presentation is included as a resource.
Create a JSON File Exercise

This lecture is actually a hands-on exercise. Create a JSON file according to the given specifications.

JSON Quiz
Please answer the following questions about JSON.
Documenting JSON
Covers:
  • How JSON is used for both requests and responses
  • Documenting a JSON element
  • Documenting acceptable values
  • Documenting element nesting
JSON Documentation Exercise
This lecture is an exercise where you will document three JSON files.
JSON Documentation
Answer these questions about JSON documentation:
Requirements
  • A text editor (such as Notepad or Atom) and a Word Processor (such as MS Word, Apple Pages, or Google docs)
Lecturers
Peter Gruenbaum
Peter Gruenbaum
President, SDK Bridge
Platform
/storage/img/providers/udemy.svg
Udemy courses are suited to professional development. The platform is organized in such a way that it is experts themselves that decide the topic and when the course will start. All supporting documents are made available to you for lifetime access. On this platform, you can find a course on about any subject, and that is no exaggeration – from a tutorial on how to ride a motorcycle, to managing the financial markets. The language and the course format are established by the teacher. This is why it is important to read the information about the course carefully before parting with any money.
Rating
4.5
(1811)
(1270)
(320)
(37)
(15)
Comments (3336)
Like any other website, konevy uses «cookies». These cookies are used to store information including visitor's preferences, and the pages on the website that the visitor accessed or visited. The information is used to optimize the users' experience by customizing our web page content based on visitors' browser type and/or other information. For more general information on cookies, please read the «What Are Cookies» article on Cookie Consent website.