Comments
Our 2020 First Quarter Newsletter is now available on our website:
http://www.stcidlsig.org/
Check it out for news about our new editor, elections and other SIG topics.
Remember, everyone is welcome to submit article any time.
If you’re starting to document a REST API, this workshop is for you.
Join Tom Johnson for a full day workshop on #API Documentation at the Society for Technical Communication Summit on Sun, May 5 in Denver, CO.
In this workshop, you’ll learn about API documentation in the context of using a simple weather API — making requests and analyzing the responses. We’ll cover the essential elements of API reference topics (such as endpoints, parameters, and response schemas), how OpenAPI specification and Swagger work (as well as tools to simplify spec development), expected non-reference topics (such as authorization and rate limiting), version control workflows (in Git and GitHub), and more. If you’re starting to document a REST API, this workshop will get you up and running in the right direction. You’ll leave with a solid grasp of the necessary components of REST API documentation as well as how to deliver an interactive learning experience that developers want.
Takeaways:
- REST APIs involve requests and responses, not too unlike visiting a web page — you make a request to a resource stored on a server, and the server responds with the requested information.
- Web API reference topics have essential sections: resource descriptions, endpoints and methods, parameters, request examples, and response examples + schemas.
- The OpenAPI specification provides a standard structure for describing your REST API; Swagger UI can consume the OpenAPI spec to provide interactive documentation.
Rates and list of all Summit workshops here:
STC Summit Track spotlight ...
The "Training Development and Delivery" track at this year's Summit in Denver May 5-8 features sessions on the training industry as a whole including synchronous onsite and online classes and the creation of effective eLearning. Presentations cover the tools, tactics, strategies, and techniques needed to deliver robust courses that enhance the learner experience no matter the pedagogy.
The Track Manager is a leader in this field, Kevin Siegel
Featured sessions:
- Teaching Online: Tips, Tricks, Techniques for Engaging Virtual Learners, Kevin Siegel
- xAPI: Geek Free Introduction for Instructional Designers, Megan Torrence
- The Human Touch: Bringing Instructor Presence into eLearning, Julia Cho
- eLearning: Creating Virtual Reality Projects with Adobe Captivate, Kevin Siegel
- Visual Media: Crossing Paths with Technical Publications, Keith Kamikawa
- Engineering Better Training Experiences Through Innovative Presentation Techniques and Technologies, Chuck Campbell
- Just-in-Time (JIT) Training, Aaron Murray
- More Lessons Learned: What Harry Potter Professors Teach Us About Instructional Design, Jamye Sagan
- Documented Disconnect: Gender Bias in Onboarding Technical Documents, William Hart
Full descriptions of each session here:
Our IDeaL newsletter went out today! Check it out!
I'm polishing up the Q3 IDeaL newsletter! It goes out Sept. 25!