Join Peter Gruenbaum for an in-depth discussion in this video XML documentation solution, part of Learn API Documentation with JSON and XML.
- [Instructor] Let's take a look at the solutions…for the XML documentation exercise.…Here you were asked to document a…request to record a television program.…So this looks very much like what you've seen before,…you've got one sentence that describes the request…and then you've got a table that describes everything else.…So because this is a request, there's a required column…and that's going to have sections…that say required and optional.…Let's look at the underlying markdown.…
The main thing to note here is that you have a top level…for recordtv, and then the other ones are all indented…so you use the spaces again to do that indentation.…You can also notice what I put in the notes section here,…first of all the format.…Because this is optional, I put in a default,…which is today's date.…Now the time element has an attribute, which is the format,…so I put that information to the notes section.…I said attributes, its format, and it has values of 24 or 12…and that's for 24 or 12-hour format.…
Another thing to note is that for the duration…
- 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
Agile Project Management Principleswith 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.