Shuffle ball change: Sashay your way to clearer API documentation

on YouTube ↗34m

" summary

Claims a practical path: she cleans scattered microservice references with a spreadsheet to model every endpoint, authors an OpenAPI spec in OpenAPI YAML with Redoc Pro and moves tooling from Go Swagger to swagger yard, balances owning a spec while keeping up with five developers, edits commits directly in feature branches, and introduces a style guideline that increases consistency. Automation adds reviewers via a GitHub action adds docs team as reviewers. Outcome: clearer, more consistent API reference readying internal and external use.

AI-written summary · about

" chapters (13)

1. 0:00Start
2. 2:03Secret Benefits
3. 3:02How We Provide Value to an Organization
4. 8:22Preparation
5. 11:39Authoring and Maintaining the Api Spec
6. 16:31Api Documentation Guidelines for Back-End
7. 20:56Feedback
8. 26:54Impact the Process
9. 28:13How Much Programming Ability Did You Have under Your Belt before Getting into Api Docs
10. 29:18Suggestions on Beginner Languages
11. 30:16How You Got Yourself To Be Automatically Listed as a Reviewer in Github
12. 31:44Was the Tech Writer Involved in the Sprint Review
13. 32:33How Do You Find Projects That Need some Api Doc Help

" related talks

• 35mDocumenting APIs: new era, same craftJavier Rubio · Write the Docs Berlin 2026
• 21mLet there be docs!Svyatoslav Kryukov · Friendly.rb 2023
• 38mZen And The Art Of Automanually Creating API Documentation - An Inquiry Into ProcessDan Grabski · Write the Docs Portland 2023
• 01h 01mOpenAPI & .NET: You're Doing It WrongMark Rendle · NDC London 2023
• 35mOpenAPI for DocumentariansLorna Jane Mitchell · Write the Docs Atlantic 2023
• 24mBuilding an Accessible API Spec with Traditional Engineering TeamsGriffin Solot-Kehl · apidays Paris 2021
• 27mGetting developers hooked on your APINicolas Garnier · Codemotion Amsterdam 2016
• 46mOpenAPI & .NET: You're Doing It Wrong!Mark Rendle · Build Stuff 2023