Курс Learn API Technical Writing: JSON and XML for Writers

3 336 комментариев
Обучение платное
Сертификация бесплатная
1.5 часа курса
О курсе

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.

Understand what structured data is and why it is important.


  • 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
  • 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.
Understand and document structured data files in the JSON format
What is JSON and How Does It Work?
  • 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.

Please answer the following questions about JSON.
Documenting JSON
  • 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:
  • A text editor (such as Notepad or Atom) and a Word Processor (such as MS Word, Apple Pages, or Google docs)
Что Вы изучите?
  • 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.
Peter Gruenbaum
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. 

Курсы Udemy подойдут для профессионального развития. Платформа устроена таким образом, что эксперты сами запускают курсы. Все материалы передаются в пожизненный доступ. На этой платформе можно найти курс, без преувеличений, на любую тему – начиная от тьюториала по какой-то камере и заканчивая теоретическим курсом по управлению финансовыми рисками. Язык и формат обучения устанавливается преподавателем, поэтому стоит внимательно изучить информацию о курсе перед покупкой.
1 811
1 270