Join Peter Gruenbaum for an in-depth discussion in this video What you should know, part of Learn API Documentation with JSON and XML.
- [Instructor] Let's discuss what you should know before taking this course. This course is designed for technical writers who want to learn about API documentation, so you should be comfortable with writing about technical topics. It's also good for project managers who want to be able to document JSON and XML. It's almost easier to say what you don't need to know. No prior knowledge of JSON or XML is required. Now, if you already understand JSON or XML, there's still plenty of material about how to document them. Also, no coding experience is required.
If you know anything about computer programming, let's say you took a Java course a while ago, it certainly won't hurt. Some of the information, like data types, have some overlap with computer programming. API documentation is different than end user documentation, and to enjoy this kind of work, there's some things you should like. You should enjoy working with data, you should enjoy describing things precisely, and you should enjoy learning about how technology works.
- 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