API Documentation Workshop (Raleigh): Video 2 of 5
I'd Rather Be Writing podcast
@idratherbewritingAbout
Videos for the podcasts on https://idratherbewriting.com, which covers topics related to technical writing, API documentation, AI, content strategy, developer experience, and more.
Latest Posts
Video Description
This API documentation workshop video is part of a full-day API workshop I gave in Raleigh, North Carolina, on April 6, 2019. This video is part of a series of 5 videos (collected as a playlist). In this section, we cover the main sections in API reference documentation. The corresponding section in my course is here: https://idratherbewriting.com/learnapidoc/docendpoints.html. These main sections include the following: * Resource description * Endpoints and methods * Parameters * Request example * Response example and schema You can view more information about documenting APIs on my site, https://idratherbewriting.com/learnapidoc. If you're interested in having me give an API documentation workshop to your company or group, contact me at https://idratherbewriting.com/contact/. The following links point to all videos in this series: Workshop video 1: https://www.youtube.com/watch?v=FG3cDrY-6CE Workshop video 2: https://www.youtube.com/watch?v=L4YFlSB8STI Workshop video 3: https://www.youtube.com/watch?v=8vkt3hftD1k Workshop video 4: https://www.youtube.com/watch?v=iLl-VpoEFrE Workshop video 5: https://www.youtube.com/watch?v=xEzZl7L58e4
API Doc Workshop Must-Haves
AI-recommended products based on this video

HQCME 9 Pack Lined Sticky Notes, 4X6 in, 9 Pastel Colors Large Ruled Stickies Colorful Super Sticking Power Memo Pads Strong Adhesive, Sticky Notes with Lines for Home, Office

Dell 24 Monitor - SE2425HM - 23.8-inch Full HD (1920x1080) 16:9 100Hz Display, IPS Panel, 16.70 Million Colors, Anti-Glare, 1 HDMI / 1 VGA Port, TÜV Rheinland 3-Star*, Comfortview Plus - Black

Dell S2425HS Monitor - 23.8 Inch, FHD (1920x1080) Display, 100Hz Refresh Rate 1500:1 Contrast Ratio, TÜV Rheinland Eye Comfort 4 Star, Integrated 2x5W Speaker, Height/Tilt/Swivel/Pivot - Ash White

USB C Docking Station Dual Monitor for Dell Hp,15-in-1 Laptop Docking Station 3 Monitors USB C Hub with Dual 4K HDMI,8K DP,Button,PD Charging,Ethernet,6 USB A&C,SD/TF, Audio USB-C Multiport Adapter

Dell 24 Monitor - P2425H EPEAT

Logitech G203 Wired Gaming Mouse, 8,000 DPI, Rainbow Optical Effect LIGHTSYNC RGB, 6 Programmable Buttons, On-Board Memory, Screen Mapping, PC/Mac Computer and Laptop Compatible - Black

Logitech G305 LIGHTSPEED Wireless Gaming Mouse, Hero 12K Sensor, 12,000 DPI, Lightweight, 6 Programmable Buttons, 250h Battery Life, On-Board Memory, PC/Mac - Black




