Learn API Technical Writing: JSON and XML for Writers (Udemy.com)
API Documentation 1: Teaches technical writers how to document structured data. No programming experience required.
Created by: Peter Gruenbaum
Last updated October 2023
Our take
Based on the ratings of 14,004 students, a sample of their written reviews and the syllabus, as the course stood in October 2023. No course pays to be reviewed.
This is a short primer for technical writers who have never documented an API. Peter Gruenbaum teaches how to read JSON and XML, then how to write documentation for them. The syllabus shows 16 lectures in four sections, about 83 minutes of video, plus five quizzes and hands-on exercises. No programming is needed, just a text editor and a word processor. It is the first in a series, so it covers the groundwork and stops there.
Reviewers like how clear and unhurried it is. The words that keep coming up are concise, beginner friendly and well designed, and several say the exercises in each section helped the ideas stick. The teaching gets called amazing. The complaints are fair too. One reviewer found it very basic and said a few YouTube videos would cover it. Another wanted a quick look at tools such as Swagger, and one beginner felt a lecture moved too fast. The last update was October 2023, and a reviewer says it could use a refresh.
Close to nine in ten ratings are four or five stars, and about 63,000 students have taken it. It is paid, but it is short enough to finish in an afternoon. If you are a writer moving toward API work, it is a low-risk place to start. If you already know JSON, skip it, because the basics will feel slow and the tooling is left for later.
Pros
- Plain, unhurried walkthroughs of JSON and XML that suit people with no coding background
- Four hands-on exercises have students build and document real JSON and XML files
- Narrated, real-time writing of documentation shows the process, not just the theory
- Short enough to finish in an afternoon, about 83 minutes of video
Cons
- Stays basic. One reviewer wanted more complex schemas and called it thin for the money
- No look at tools such as Swagger, which one reviewer hoped to see
- Last updated October 2023, and a recent reviewer says it needs refreshing
Easy to learn basics of API writing. Very interactive and exercises on each section helps to understand the concepts better.
Suits writers with end-user documentation experience but no coding. Those who already read JSON may find it light.
What you will 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.
Course content
4 sections · 16 lectures · 1.4 hours of video 5 quizzes, 4 articles
- 1Introduction 2 free previews3 lectures · 1 quiz · 12 min
- 2JSON5 lectures · 2 quizzes · 25 min
- 3XML4 lectures · 2 quizzes · 20 min
- 4Final Words4 lectures · 14 min
Who it is for
The instructor says it suits
- 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 need before you start
- A text editor (such as Notepad++ or Atom) and a Word Processor (such as MS Word, Apple Pages, or Google docs)
How it compares
Against the other 1,182 rated Udemy courses in IT & Software on CourseDuck:
- Rating4.6 out of 5higher than 67% of them
- Reviews14,004#28 of 1,183 by number of reviews
- Length1.4 hoursshorter than 91% of them
- Last updatedOctober 2023earlier than 70% of them
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.
Instructor Details
- 4.6 Rating
14,004 Reviews
Peter Gruenbaum
Peter founded SDK Bridge to bring together his love of technology and writing. After getting a PhD in solar energy research, he spent 10 years as a software developer and writer. 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. He currently works for Calibrant Energy, building software to control solar and wind farms with batteries. Peter received his BA in Physics from the University of Chicago and his PhD in Applied Physics from Stanford University.
More courses by Peter Gruenbaum
Learn Swagger and the OpenAPI Specification (2026)
4.5 (6,068 Reviews)
Provider: Udemy
Time: 1.1h
$11.99
Learn API Technical Writing 2: REST for Writers (2023)
4.6 (3,710 Reviews)
Provider: Udemy
Time: 1.8h
$13.99
Introduction to Software for Renewable Energy (2024)
4.5 (39 Reviews)
Provider: Udemy
Time: 48 mins
$19.99
More IT & Software courses
D3.js Data Visualization Fundamentals - Hands On (2026)
4.9 (3,917 Reviews)
Provider: Udemy
Time: 4.6h
$49.99
Hands-On Training: Streaming Data with Apache Kafka on Azure (2025)
4.9 (103 Reviews)
Provider: Udemy
Time: 3.7h
$10.99
Oracle Grid Infrastructure and RAC using Oracle Database 19c (2026)
4.8 (2,499 Reviews)
Provider: Udemy
Time: 8.7h
$19.99
PowerShell Scripting & Automation: The Complete Hands-On (2026)
4.8 (1,750 Reviews)
Provider: Udemy
Time: 9.6h
$11.99
AWS EC2 Crash Course + Load Balancing with Demos and PDFs (2025)
4.8 (866 Reviews)
Provider: Udemy
Time: 3.7h
$19.99
Reviews
By Sneha Tojo Kanichai on 2/19/2025
This course is well designed in a way that suits beginners. However, I was hoping for a brief overview of some of the tools, such as swagger. But, overall I feel more confident about API documentation now.
By Anna Gaiel Natorilla on 3/26/2024
This is a great starting point for people with a different specialization when trying to learn about simple API documentation. Presentation is simple enough for a layperson without programming know-how or experience to understand. Thanks for using tables in the visuals alongside the examples - these were helpful.
By Annette Kay Donnell on 7/24/2020
Excellent for writers who are new to API documentation. The examples were extremely helpful, as were the exercises. The 1.5 hours to take the course is a joke! First, any writer is going to take notes. Second, the exercises take way more than 3 minutes. The course took me about 5 hours.
By Ahsan Qazi on 7/1/2020
Thank you for such a great and an informative course. This was great in introducing the skillset and the training required for API documentation. The instructor has done a great job in teaching the relevant content that one needs to learn and exercises are also very much relevant to the content. One minor suggestion for the instructor would be to speak a little slower because it is a little difficult to take notes while he is speaking fast. Since the instructor covers a lot of technical and foundational knowledge, I took notes on every single concept he taught. I had to rewind multiple times to make sure I did not miss anything because of the great depth of knowledge shared here. Overall, excellent course.
By Vinod Kumar Purushotham on 5/23/2020
Peter has good knowledge of API documentation. As this is an introductory part the topics are not tough. He explained the concepts in a simple manner that can be easily grasped by a non-techie. I think Peter should include more JSON and XML exercises so that the students can practice more to increase their confidence level before enrolling for part2.
By Gunjan Sarojwal on 6/9/2017
This is an excellent course for technical writers who want to take up API documentation. It gives examples and set of exercises with a very simple and clear description. One can also raise queries anytime during the course. Being a self-paced learning program, it gives the ease to learn new concepts at our comfortable speed.
By Loren Robinson on 8/4/2016
It is a very good course. I am currently a full time technical writer and this course helped me begin my journey on learning API technical writing because that is the kind of technical writing I want to transition into. And I will be taking more of his API technical writing courses on here.
By Rita Johnson on 8/1/2016
I originally signed up for this course over a year ago. Since then I am in a technical writing position where I need to work with APIs. I also have been using Flare. So I feel I have a better feel for HTML and XML. I successfully completed the course exercises because of this experience.
By Marc Baker on 3/8/2016
I thought the course was well-prepared and well-delivered, but there were some natural mistakes (e.g. typos) that the instructor is endeavoring to address. For an introductory course it would have been nice to get even a broad-brush overview of the API world. As it is, we have to take for granted that as Peter says in his summary "this course is a big chunk of it." We really don't know how much of the API world JSON and XML comprise, nor do we know how much of either is commonly used by developers in typical web dev. or why they use JSON vs. XML. They just "are," which leaves me hanging a bit. It also would have been nice to know WHY tables are a good way to document JSON and XML files. Are there alternative methods? Are tables in doc more useable by external dev's? I guess most of this is obvious to experienced API writers, but for someone breaking in to the discipline, it's mystifying. I feel satisfied that the course was adequate for the _discount_ price paid.
By John Ertel on 4/27/2015
I've never documented APIs but keep seeing it in job descriptions. This course provided a lot of great information and now I feel informed and confident. The instructor is excellent and explains all concepts clearly and concisely. The exercises are hands-on and instructive. I recommend this course.
Quality Score
No CourseDuck member has rated this course yet. Taken it? Give each part a thumbs up or down.
Overall Score : 92 / 100












