You can actually use JSON and XML to write documentation. Tools read in the structured data and automatically generate documentation in HTML. JSON is used for web API documentation in tools like Swagger and I/O Docs. XML schemas can be used to document XML. However, these automated systems can be limited when needing to describe complex infornation.
- [Instructor] Up until now we've been talking…about how to document structured data.…Now I want to briefly talk about how you can use…structured data for documentation itself.…There are tools that take structured data…and generate documentation from them.…And now that you understand Json and XML,…you'll be in better shape to create documentation…for these tools.…When you create documentation using structured data,…then the documentation is machine readable.…Essentially a computer can read it in…and do something with it beyond just presenting it to…a reader.…
For example, it can do automated testing,…and make sure that every element in a Json file…has some kind of description in it's documentation.…It can also create interactive documentation,…where you can try out an API call…from within the documentation.…Creating documentation from structured data…is called autogenerated documentation.…Let me show you an example.…This is autogenerated documentation using a tool…called Swagger.…This is for a web API that interacts with a database,…
- The purpose of documentation
- Data types
- Structured data
- Writing JSON and XML
- Documenting one-level JSON responses
- Documenting nested JSON responses
- XML attributes and examples
- Documenting XML
- Structuring data documentation
Skill Level Intermediate
Project Management: Iterative Methodswith Bob McGannon1h 16m Appropriate for all
Technical Writing: Reportswith Judy Steiner-Williams2h 30m Appropriate for all
Introduction to JSON and XML Documentation
Next steps1m 10s
- Mark as unwatched
- Mark all as unwatched
Are you sure you want to mark all the videos in this course as unwatched?
This will not affect your course history, your reports, or your certificates of completion for this course.Cancel
Take notes with your new membership!
Type in the entry box, then click Enter to save your note.
1:30Press on any video thumbnail to jump immediately to the timecode shown.
Notes are saved with you account but can also be exported as plain text, MS Word, PDF, Google Doc, or Evernote.