mailerliner.blogg.se - Technical document writer

TECHNICAL DOCUMENT WRITER HOW TO
TECHNICAL DOCUMENT WRITER GENERATOR
TECHNICAL DOCUMENT WRITER SOFTWARE
TECHNICAL DOCUMENT WRITER CODE

Will this course help you get a job in API documentation?.

How long will it take to finish the course?.

TECHNICAL DOCUMENT WRITER HOW TO

You’ll learn about the required sections in API documentation, analyze examples of REST API documentation from various companies, learn how to join an open-source project to get experience, and more. We’ll then transition into standards, tools, and specifications for REST APIs. Immersion in real scenarios makes these tools and technologies more meaningful. The idea is that rather than learning about these concepts independent of any context, you learn them by immersing yourself in a real scenario while using an API.

You’ll first learn about API documentation by using a simple weather API to put a weather forecast on your site.Īs you use the API, you’ll learn about endpoints, parameters, data types, authentication, curl, JSON, the command line, Chrome’s Developer Console, JavaScript, and more. In this course on writing documentation for APIs, instead of just talking about abstract concepts, I contextualize APIs with a direct, hands-on approach.

Menlo Park API workshop video recording.

What's wrong with this topic answer key.

Activity: Get wind speed using the Aeris Weather API.

Activity: Retrieve a gallery using the Flickr API.

Activity: Get event information using the Eventbrite API.

Quality checklist for API documentation.

Different approaches for assessing information quality.

Measuring documentation quality through user feedback.

TECHNICAL DOCUMENT WRITER SOFTWARE

Ensuring documentation coverage with each software release.

Broadcasting your meeting notes to influence a wider audience.

Sending doc status reports - a tool for visibility and relationship building.

Managing content from external contributors.

Documentation kickoff meetings and product demos.

Following agile scrum with documentation projects.

DX content strategy with developer portals.

Create non-ref docs with native library APIs.

TECHNICAL DOCUMENT WRITER GENERATOR

Doxygen, a document generator mainly for C++.

Activity: Generate a Javadoc from a sample project.

Activity: Create or fix an API reference documentation topic.

Best locations for API documentation jobs.

The job market for API technical writers.

Case study: Switching tools to docs-as-code.

Jekyll and CloudCannon continuous deployment tutorial.

Which tool to choose for API docs - my recommendations.

Blobr: An API portal that arranges your API's use cases as individual products.

Using Oxygen XML with docs-as-code workflows.

Activity: Pull request workflows through GitHub.

Activity: Use the GitHub Desktop Client.

Activity: Manage content in a GitHub wiki.

TECHNICAL DOCUMENT WRITER CODE

What research tells us about documenting code.Common characteristics of code tutorials.Activity: Assess the conceptual content in your project.Activity: Complete the SendGrid Getting Started tutorial.Activity: Test your project's documentation.Activity: Create an OpenAPI specification document.OpenAPI tutorial using Swagger Editor and Swagger UI: Overview.Redocly tutorial - authoring and publishing API docs with Redocly's command-line tools.Integrating Swagger UI with the rest of your docs.Getting started tutorial: Using Stoplight Studio to create an OpenAPI specification document.Stoplight: Visual modeling tools for creating your spec.Introduction to the OpenAPI specification.Overview of REST API specification formats.IV: OpenAPI spec and generated reference docs.Activity: Evaluate API reference docs for core elements.Activity: What's wrong with this API reference topic.Inspect the JSON from the response payload.Developer Documentation Trends: Survey Results.