Learn API Technical Writing: JSON and XML for Writers

API Documentation1: Teaches technical writers how to document structured data. No programming experience required.
4.6 (222 ratings) Instead of using a simple lifetime average, Udemy calculates a
course's star rating by considering a number of different factors
such as the number of ratings, the age of ratings, and the
likelihood of fraudulent ratings.
1,409 students enrolled
$25
Take This Course
  • Lectures 15
  • Contents Video: 1 hour
    Other: 15 mins
  • Skill Level Beginner Level
  • Languages English
  • Includes Lifetime access
    30 day money back guarantee!
    Available on iOS and Android
    Certificate of Completion
Wishlisted Wishlist

How taking a course works

Discover

Find online courses made by experts from around the world.

Learn

Take your courses with you and learn anywhere, anytime.

Master

Learn and practice real-world skills and achieve your goals.

About This Course

Published 1/2015 English

Course Description

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.

What are the requirements?

  • A text editor (such as Notepad or TextEdit) and a Word Processor (such as MS Word, Apple Pages, or Google docs)

What am I going to get from this course?

  • 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.

What is the target audience?

  • Technical writers with experience writing end-user documentation and how want to learn how to write API documentation. No prior programming or structured data experience is required.
  • Technical writers with programming experience who want details on best practices for documenting structured data.

What you get with this course?

Not for you? No problem.
30 day money back guarantee.

Forever yours.
Lifetime access.

Learn on the go.
Desktop, iOS and Android.

Get rewarded.
Certificate of completion.

Curriculum

Section 1: Introduction
06:29

Covers:

  • Teacher's background and credentials
  • What are APIs?
  • Why is API documentation important?
  • JSON, XML, and how they compare
  • Class overview
04:44

Covers:

  • Data types
  • Boolean values
  • Structured data
3 questions

Please answer the following questions about data types.

Article

For this class, you'll be creating JSON and XML files. This lecture recommends some tools you can use.

Section 2: JSON
08:01

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.

2 pages

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

4 questions

Please answer the following questions about JSON.

16:52

Covers:

  • How JSON is used for both requests and responses
  • Documenting a JSON element
  • Documenting acceptable values
  • Documenting element nesting
3 pages

This lecture is an exercise where you will document three JSON files.

3 questions

Answer these questions about JSON documentation:

Section 3: XML
10:59

Covers:

  • What is XML?
  • Tags and Content
  • Attributes
  • Nesting
  • Namespaces and Comments
  • Indentation
  • Schemas

On completion, students will be able to read and understand XML files.

3 pages

This lecture is an exercise where you will create three XML files according to specifications.

2 questions

Please answer the following questions about XML.

08:49

Covers:

  • Differences between XML documentation and JSON documentation
  • Documenting attributes
  • Using multiple tables

On completion, students will know the basics of how to document XML.

3 pages

This lecture is an exercise where you will document three XML files.

3 questions

Answer the following questions about XML documentation:

Section 4: Final Words
Article

Covers what kinds of tools are available for documenting JSON and XML.

06:01

Covers:

  • Why use structured data for documentation
  • Using JSON to describe APIs
  • Using XML to describe XML (XSD)
  • Disadvantages to this approach
04:55

Covers:

  • Review of everything you've learned in this course
  • What is the next step for learning to document APIs
Article

Learn how to document REST APIs.

Students Who Viewed This Course Also Viewed

  • Loading
  • Loading
  • Loading

Instructor Biography

Peter Gruenbaum, President, SDK Bridge

Peter founded SDK Bridge to bring together his love of technology and writing. After 10 years as a software developer, he learned the skill of API writing at Microsoft. Since then, he has worked as an API writer to describe APIs for eCommerce, automobile traffic prediction, electric utilities, mobile phones, and tractors, just to name a few. In addition to API and SDK documentation, he creates video tutorials for software developer audiences. Peter received his BA in Physics from the University of Chicago and his PhD in Applied Physics from Stanford University.

Ready to start learning?
Take This Course