Creating API Documentation and Developer Portals Course
An affordable way to master the skills of API documentation writing
Enrol in Course
Cherryleaf’s popular online training course teaches you how the keys skills of writing and managing an API developer portal. You’ll gain confidence you’re approaching each writing project in the right way, and creating content that follows best practice.
Who is this course for?
This course is for anyone responsible for managing, planning or writing API documentation. For example:
- Developers wanting to provide API documentation that is complete and meets the needs of the users.
- Developers wanting to discover best practices in API documentation and developer portals
- Technical Authors/Writers wanting to understand APIs and how to write documentation for them.
Recommended by the ASTC
This course is recommended by The Australian Society for Technical Communication and The Technical Communicators Association of New Zealand to their members. It’s a great way to maintain the Continuing Professional Development (CPD) required by technical communication societies.
Why attend this course?
We use publicly accessible APIs, as part of this course.
We also show examples of developer portals from the DevPortal awards, Google, Microsoft, and others.
No programming experience is required.
Who is this course for?
This course is for anyone responsible for managing, planning or writing API documentation.
For example:
- Developers wanting to provide API documentation that is complete and meets the needs of the users.
- Developers wanting to discover best practices in API documentation and developer portals
- Technical Authors wanting to understand APIs and how to write documentation for them.
Technical information
- The course modules are delivered over the Web in small, manageable video presentations. You can pause the videos at any time and return to the course at times that suit you.
- You can download the course handouts.
- You have the option of taking the course on an iPhone or iPad, using the MyTeachable app in the Apple App Store.
- You can preview some of the course modules.
- There are a few free applications that you’ll be using, which you’ll need to install these before you start the course.
Billing information
- You can pay by credit/debit cards or PayPal.
- The courses are hosted and sold by via the Teachable platform. From a VAT perspective, they are the “Merchant of Record”, and receipts contain their VAT number.
Need to train your whole team?
If you have five or more people who you would like to take the course, we can offer a group booking option. Delegates get access for 12 months. Contact us for details.
Your Instructor
Cherryleaf is a technical writing services company formed in 2002 by people with a passion for technical communication and learning development.
Cherryleaf is recognised as a leader within the technical communication profession. Our staff have written articles for the Society for Technical Communication's (STC) Intercom magazine, the Institute of Scientific and Technical Communicator's Communicator journal and tekom's TCWorld magazine. They've also written books on technical communication. We've presented webinars for Adobe, Madcap Software or the STC, and we've spoken at various conferences around the world.
Today, organisations throughout Europe use Cherryleaf’s services so they can provide clear information that enables users and staff to complete tasks productively.
Course Curriculum
-
StartIntroduction (4:52)
-
StartWhat is an API? (23:39)
-
StartUsing an API (23:28)
-
StartHow APIs are created (1:24)
-
StartAuthentication and accreditation (17:53)
-
StartWhat documentation should I write? (17:12)
-
StartThe Overview section (7:04)
-
StartThe Concepts section (2:16)
-
StartThe Getting Started section (5:43)
-
StartThe API Reference section (2:20)
-
StartWriting the API reference by hand (12:31)
-
StartCookbooks (3:46)
-
StartTutorial/Colab/Code labs (3:27)
-
StartOne-pagers (1:23)
-
StartThe Case Study section (2:21)
-
StartThe FAQs/Troubleshooting section (2:08)
-
PreviewCheat sheets (2:25)
-
StartRelease notes (Changelog) (2:22)
-
StartOther content (3:13)
-
StartOnboarding (2:11)
-
StartWriting code samples (5:56)
-
StartDocumentation - summary (1:18)
-
StartDesign patterns in developer portals (14:52)
-
StartAuthoring tools for API documentation (37:33)
-
StartManaging an API documentation project (17:53)
-
StartSummary (2:58)