

Discover more from API Documentation
API Documentation - #02
Highlights: Free technical writing courses, Communicating warning information in HTTP APIs, How to manage documentation as code.
Technical Writing
๐Free technical writing coursesย - Google released an education platform to train engineers on technical writing. The portal comes with two modules to learn about planning and authoring technical documents.
๐How to develop a combined content audit and planย - Debra Kahn wrote a guide for recognizing which content from a website needs improvement and how to frame the next actions in a spreadsheet.
๐ย Using numbers in technical documentsย - ClickHelp shared a set of ground rules and tips for using numbers in user manuals.
Developer Experience
๐นย Communicating warning information in HTTP APIsย - Andre Cedik summarizes how well-known APIs are returning errors. To make "soft error handling" easier for future API development, he also proposes a draft RFC for communicating warning information in HTTP APIs.
๐ย REST API: Sorting, filtering, and paginationย - Tania Rascia documented how to create pagination, filtering, and sorting endpoints. The article highlights the key points to take into account when designing an API.
๐นย ย The augmented API design reviewerย - Arnaud Lauret showcased how to enforce API Design guidelines using the OpenAPI Specification and Spectral, a JSON/YAML linter.
Docs as Code
๐ฆHow to manage documentation as codeย - David Garcia proposed a basic workflow to start treating documentation as code in just ten tweets.
๐ย GitHub CLI 1.0 is now availableย - GitHub released the 1.0 version of their CLI. The command-line tool allows you to run your entire GitHub workflow from the terminal, from issues to releases.