Learning Lab Home/Product Management/Learn API Technical Writing: JSON and XML for Writers

Learn API Technical Writing: JSON and XML for Writers

In partnership With
Udemy
4.5
(38,384)

Topic:

API Documentation 1: Teaches technical writers how to document structured data. No programming experience required.

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.

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.
Course
Intermediate
Careers

Careers Related to Learn API Technical Writing: JSON and XML for Writers

Certifications

Certifications related to Product Development or API

General Assembly’s Product Management course teaches the end-to-end product management (PM) process to a real-world scenario, from evaluating users and managing a roadmap to creating a minimum viable product (MVP) and developing metrics.

 

What you'll accomplish

This is a beginner-friendly program with no prerequisites, although students may have had exposure to product development concepts or be informally taking on PM responsibilities in their current role. Throughout this expert-designed program, you’ll:

  • Determine key risks and assumptions of a product in order to prioritize research and discovery work.
  • Validate hypotheses by gathering user feedback via MVPs, interviews, experiments, and testing.
  • Execute competitive research to highlight market gaps and trends.
  • Speak fluently with developers, user experience designers, and other business stakeholders about priorities, requirements, and workflow.
  • Apply metrics alongside objectives and key results (OKRs) to measure a product’s success and track its life cycle.
  • Apply what you’ve learned to create a portfolio project: a presentation detailing your product creation strategy.

 

Why General Assembly

Since 2011, General Assembly has graduated more than 40,000 students worldwide from the full time & part time courses. During the 2020 hiring shutdown, GA's students, instructors, and career coaches never lost focus, and the KPMG-validated numbers in their Outcomes report reflect it. *For students who graduated in 2020 — the peak of the pandemic — 74.4% of those who participated in GA's full-time Career Services program landed jobs within six months of graduation. General Assembly is proud of their grads + teams' relentless dedication and to see those numbers rising. Download the report here.

 

Your next step? Submit an application to talk to the General Assembly Admissions team


 

Note: reviews are referenced from Career Karma - https://careerkarma.com/schools/general-assembly

 

Udacity
Beginner
4 months
10 hours

General Assembly’s User Experience Design Immersive is a transformative course designed for you to get the necessary skills for a UX Design role in three months. 

The User Experience Design bootcamp is led by instructors who are expert practitioners in their field, supported by career coaches that work with you since day one and enhanced by a career services team that is constantly in talks with employers about their UX Design hiring needs.

 

What you'll accomplish

As a graduate, you’ll have a portfolio of projects that show your creative and technical ability to launch the next generation of successful apps, websites and digital experiences. Throughout this program, you will:

  • Identify and implement the most effective methods of user research to gain a deeper understanding of what users want and need.

  • Use interaction and visual design techniques to craft a dynamic digital product that brings delight and function to users.

  • Conduct usability testing to make product experiences more accessible for diverse user populations and environments.

  • Learn best practices for working within a product team, employing product management techniques and evaluating technical constraints to better collaborate with developers.

  • Produce polished design documentation, including wireframes and prototypes, to articulate design decisions to clients and stakeholders.

  • Prepare for the world of work, compiling a professional-grade portfolio of solo, group, and client projects.

 

Prerequisites

This is a beginner-friendly program with no prerequisites, although many students are familiar with common tools for graphic and web designers and some may have had exposure to UX concepts in the past. The General Assembly curriculum helps you gain fluency in end-to-end UX processes, tools, and documentation and put them to work on the path to a new career as a User Experience Designer.

 

Why General Assembly

Since 2011, General Assembly has graduated more than 40,000 students worldwide from the full time & part time courses. During the 2020 hiring shutdown, GA's students, instructors, and career coaches never lost focus, and the KPMG-validated numbers in their Outcomes report reflect it. *For students who graduated in 2020 — the peak of the pandemic — 74.4% of those who participated in GA's full-time Career Services program landed jobs within six months of graduation.  General Assembly is proud of their grads + teams' relentless dedication and to see those numbers rising. Download the report here.

 

Your next step? Submit an application to talk to the General Assembly Admissions team


 

Note: reviews are referenced from Career Karma - https://careerkarma.com/schools/general-assembly

Udacity
Beginner
4 months
10 hours

Product Managers are responsible for designing and delivering a profitable product or feature into the market. In this program, you will learn to define product strategy and KPIs based on market analysis, pitch a product vision to get stakeholder buy-in, and design a user-centered prototype that adheres to engineering constraints. Then, you will develop an execution timeline that handles competing priorities, communicate a product roadmap that builds consensus amongst internal stakeholders, and create a comprehensive go-to-market plan based on product KPIs. Finally, you will build tests to enhance product features based on market data.

Udacity
Beginner
4 months
10 hours
Courses

Courses related to Product Development or API

Flatiron School

Join the community of Flatiron School Product Design students who have gained hands-on UX / UI design experience using modern tools like Figma and Webflow. You’ll graduate with a professional portfolio,…

Flatiron School

Whether you have zero coding knowledge, are self-taught, or are somewhere in between, this course is for you. Our course takes you from foundational skills to advanced, practical knowledge in as little as 15,…

Flatiron School

Whether you have zero coding knowledge, are self-taught, or are somewhere in between, this course is for you. Our course takes you from foundational skills to advanced, practical knowledge in as little as 15 weeks.

Flatiron School…

Udemy

This is the long-awaited sequel to the Complete Unity Developer - one of the most popular e-learning courses on the internet! Completely re-worked from scratch with brand-new projects and our…

4.7
(36681)