Common characteristics of code tutorials
I'm giving an API documentation workshop in Los Angeles, California, on January 23, 2020. You can view details on EventBrite here.
Input needed: I'm currently conducting a survey about trends in developer documentation for 2020. If you write docs for developers, please take this survey. (You can view the ongoing results viewed here.)
Code tutorials describe how developers will use your APIs and other services to achieve some end. These tutorials often involve healthy chunks of code and configuration of various services. These are the “tasks” that would be more common in end-user docs.
Code tutorials have common sections or characteristics (whether explicitly called out as such or not). Starting with a template that lists these sections can help you gather the right information when you’re developing your own tutorials.
Activity 7a: Analyze two code tutorials
Code tutorials often have the following sections or characteristics:
- Scenario description - the “why” behind the tutorial
- Tutorial outcomes - objectives or a demo of solution
- Solution overview - a birds-eye view of the solution
- Intended audience - assumptions about who the tutorial is for, skill level, point in journey
- Prerequisites - expectations about required items, configurations, or utilities for the tutorial (e.g., hardware devices, services set up, API keys, software, etc.).
- Steps - the tasks involved in the solution, often formatted as sections. The steps show an assembly order working up to final solution, building the code piece by piece as needed (like Legos).
- Examples to make it real - examples or personalized info included in the steps to make the steps more meaningful and understandable.
- Teaching moments - conceptual explanations peppered in along the way as asides or footnotes.
- Inline code comments - explanations inside the code about what’s going on.
- Conclusion, next steps - wrap-up, showing fully assembled code, pointing out next logical steps, linking to related tutorials.
The following are sample tutorials. Pick two tutorials and analyze them to see how many of the above common sections and characteristics you can find.
- Stripe - Sending emails for failed payments
- Twilio - How to build a chatbot
- GitHub - Building a CI server
- Message Buttons with Node.js
- Dropbox - Quickly integrate file upload in your web app using the Chooser
- Searching By Seller: Reviewing Information About A Seller
- How to Make a Heatmap with Mapbox GL JS
- Using the Marketing API with the Facebook Pixel
- Create a Custom Map URL
- Training Course: How to Build a Multimodal Alexa Skill
- Introduction to Populating a Website with API Data
100/151 pages complete. Only 51 more pages to go.