JSON Documentation Training Course

Everything you need to know about creating JSON and how to document it

We have trained over 750 organizations including:

Learn how to document structured data - the foundation of API documentation

Designed for technical writers who want to improve their ability to handle complex data

The ideal course for Project Managers looking to understand how to document structured data

Multiple theory sessions and 6 hands-on lab sessions for well-rounded and detailed learning


APIs are revolutionising  modern internet and as their complexity increases, there is a huge demand for skilled technical writers who can document these APIs.

This course teaches you all about JavaScript Object Notation - a lightweight data-interchange format that is easy to read and write. The course is ideal for those looking to improve their ability to handle unstructured and complex data with JSON. 

Benefits of the JSON Documentation Training Course

  • Learn how to document structured data - the foundation of API documentation. 

  • Get in-depth insight into the tools you can use to create quality documentation. 
     
  • Improve your ability to handle unstructured and complex data with JSON.

json (1)

 

JSON Documentation Course Learning Objectives:

After the completion of this course, you will be able to: 

  • Articulate what JSON really is and how it helps in API documentation.

  • Explain in your own words what some JSON data types are and give examples of the same.

  • Enhance your knowledge of White Spacing and Formatting in JSON .

  • Understand how to use JSON to describe a menu structure.

  • Understand how to document JSON with the simplest to more complex files.

  • Explain in your own words how to document JSON Requests and Responses.

  • Articulate what JSON looks like in cases of added comments on a posting.

  • Enhance your knowledge about what information should be included in the Notes column.

Feedback and Testimonials for our Courses

The playbooks training course was a good 'part-2' to the CIPR and went into greater depth in a number of areas. The day was fun and Amar kept us moving along at a good pace.
Kevin Hayes
CISO, Cyber Risk Associates

Enjoyed the course. Good mix of attendees and plenty of lively conversation. Amar steered us through it all admirably.

Russ Smith
CISO, EOL IT

Overall the course was very good. I would strongly recommend this training to anyone who is involved in Cyber Security or has control of information assets.

Kim Rose
Information Governance Officer, Wye Valley NHS Trust

It was a great workshop with a lot of interesting people and a great learning experience.

Philipp Scheiwiler
System Engineer
This was a very helpful day and opportunity to speak with a number of operational incident responders to discuss what really works in practice and not just in theory. I gained a great deal from the day, particularly around the construction of bespoke playbooks and also a variety of useful resources to inform my learning. A really good day.
Andrew Lock
Information Security Consultant

JSON Documentation Course Modules 

Module 1
  • Introduction to JSON Documentation. 
Module 2
  • JSON Basics. JSON Data Types. JSON Examples.

  • JSON to Describe a Menu structure.

  • White Space and Formatting. 
Module 3
  • Documenting JSON. JSON Responses.

  • Documentation Example - Example JSON Song. Documentation Example - Example JSON Describing a Menu. Documentation Example - Menu JSON Documentation.

  • JSON Requests. Request Example Adding a Comment.

  • What Goes in Notes? 

All trademarks, service marks, trade names, product names, service names and logos appearing on the site, or on printed or digital material are the property of their respective owners, including in Cyber Management Alliance Ltd. Any rights not expressly granted herein are reserved.

Find out more about our one day public courses or internal workshops, please complete the form below. 

  • callOr call us on:
  • +44 (0) 203 189 1422