Quality checklist for API documentation.Different approaches for assessing information quality.Measuring documentation quality through user feedback.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.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.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. ![]()
0 Comments
Leave a Reply. |