Udemy
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
Development
Web Development Data Science Mobile Development Programming Languages Game Development Database Design & Development Software Testing Software Engineering Development Tools No-Code Development
Business
Entrepreneurship Communications Management Sales Business Strategy Operations Project Management Business Law Business Analytics & Intelligence Human Resources Industry E-Commerce Media Real Estate Other Business
Finance & Accounting
Accounting & Bookkeeping Compliance Cryptocurrency & Blockchain Economics Finance Finance Cert & Exam Prep Financial Modeling & Analysis Investing & Trading Money Management Tools Taxes Other Finance & Accounting
IT & Software
IT Certification Network & Security Hardware Operating Systems Other IT & Software
Office Productivity
Microsoft Apple Google SAP Oracle Other Office Productivity
Personal Development
Personal Transformation Personal Productivity Leadership Career Development Parenting & Relationships Happiness Esoteric Practices Religion & Spirituality Personal Brand Building Creativity Influence Self Esteem & Confidence Stress Management Memory & Study Skills Motivation Other Personal Development
Design
Web Design Graphic Design & Illustration Design Tools User Experience Design Game Design Design Thinking 3D & Animation Fashion Design Architectural Design Interior Design Other Design
Marketing
Digital Marketing Search Engine Optimization Social Media Marketing Branding Marketing Fundamentals Marketing Analytics & Automation Public Relations Advertising Video & Mobile Marketing Content Marketing Growth Hacking Affiliate Marketing Product Marketing Other Marketing
Lifestyle
Arts & Crafts Beauty & Makeup Esoteric Practices Food & Beverage Gaming Home Improvement Pet Care & Training Travel Other Lifestyle
Photography & Video
Digital Photography Photography Portrait Photography Photography Tools Commercial Photography Video Design Other Photography & Video
Health & Fitness
Fitness General Health Sports Nutrition Yoga Mental Health Dieting Self Defense Safety & First Aid Dance Meditation Other Health & Fitness
Music
Instruments Music Production Music Fundamentals Vocal Music Techniques Music Software Other Music
Teaching & Academics
Engineering Humanities Math Science Online Education Social Science Language Teacher Training Test Prep Other Teaching & Academics
AWS Certification Microsoft Certification AWS Certified Solutions Architect - Associate AWS Certified Cloud Practitioner CompTIA A+ Cisco CCNA Amazon AWS CompTIA Security+ AWS Certified Developer - Associate
Graphic Design Photoshop Adobe Illustrator Drawing Digital Painting InDesign Character Design Canva Figure Drawing
Life Coach Training Neuro-Linguistic Programming Personal Development Mindfulness Personal Transformation Meditation Life Purpose Coaching Neuroscience
Web Development JavaScript React CSS Angular PHP WordPress Node.Js Python
Google Flutter Android Development iOS Development Swift React Native Dart Programming Language Mobile Development Kotlin SwiftUI
Digital Marketing Google Ads (Adwords) Social Media Marketing Google Ads (AdWords) Certification Marketing Strategy Internet Marketing YouTube Marketing Email Marketing Retargeting
SQL Microsoft Power BI Tableau Business Analysis Business Intelligence MySQL Data Analysis Data Modeling Data Science
Business Fundamentals Entrepreneurship Fundamentals Business Strategy Online Business Business Plan Startup Freelancing Blogging Home Business
Unity Game Development Fundamentals Unreal Engine C# 3D Game Development C++ 2D Game Development Unreal Engine Blueprints Blender
30-Day Money-Back Guarantee

This course includes:

  • 1 hour on-demand video
  • 4 articles
  • 12 downloadable resources
  • Full lifetime access
  • Access on mobile and TV
IT & Software Other IT & Software Technical Writing

Learn API Technical Writing: JSON and XML for Writers

API Documentation1: Teaches technical writers how to document structured data. No programming experience required.
Bestseller
Rating: 4.5 out of 54.5 (3,830 ratings)
16,838 students
Created by Peter Gruenbaum
Last updated 12/2020
English
English
30-Day Money-Back Guarantee

What you'll 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.
Curated for the Udemy for Business collection

Requirements

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

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.

Who this course is for:

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

Featured review

Akshaya Barshile
Akshaya Barshile
4 courses
3 reviews
Rating: 5.0 out of 5a month ago
the details are quite interesting ... the best part is the quick review of the lecture is seriously helpful for recollecting the previous data... am flattered with the simple explaination of the complex technical terms.. a little fast though, but the lecture gives the feature to slow it down as per the need ... its good to learn this way ... thanks sire!!!

Course content

4 sections • 16 lectures • 1h 23m total length

  • Preview06:29
  • Preview04:44
  • Identify Types of Data
    3 questions
  • Tools for Writing JSON and XML
    00:43

  • What is JSON and How Does It Work?
    08:01
  • Create a JSON File Exercise
    3 pages
  • JSON Quiz
    4 questions
  • Documenting JSON
    16:52
  • JSON Documentation Exercise
    3 pages
  • JSON Documentation
    3 questions
  • An Alternative to Indenting
    00:18

  • What is XML and How Does It Work?
    10:59
  • Create XML Exercise
    3 pages
  • XML Quiz
    2 questions
  • Documenting XML
    08:49
  • XML Documentation Exercise
    3 pages
  • XML Documentation
    3 questions

  • Tools for Writing Structured Data Documentation
    02:47
  • Using Structured Data for Documentation
    06:01
  • Review and Next Steps
    04:55
  • Bonus Lecture: Offer for Next Course in the Series
    00:42

Instructor

Peter Gruenbaum
President, SDK Bridge
Peter Gruenbaum
  • 4.5 Instructor Rating
  • 8,979 Reviews
  • 29,826 Students
  • 6 Courses

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 for Business
  • Teach on Udemy
  • Get the app
  • About us
  • Contact us
  • Careers
  • Blog
  • Help and Support
  • Affiliate
  • Terms
  • Privacy policy
  • Cookie settings
  • Sitemap
  • Featured courses
Udemy
© 2021 Udemy, Inc.