Are you a technical writer who needs to write API software documentation? Do you wonder what you need to prepare and deliver to have high-quality API documentation and don’t know where to start?
If so, then this course is for you!
This is an asynchronous course with activites that lead to a certificate of completion if done correctly.
If you’re like most content developers, you’ve been told more than once to produce a user-facing document with only a specification to guide you. Or maybe you’ve been asked to actually write a specification.
In this course, we’ll explore the nature of specifications – the most usual types, how they work, why they’re important, and how they interact with other technical documents.
Key takeaways – when you successfully complete this course, you will:
This is an asynchronous, self-guided course. The material is presented via short videos, which you can watch at your leisure.
Additional resource materials are provided, and there are activities that lead to a certificate of completion once done correctly.
Beginning to mid-level technical communicators and other content developers who use specifications as source material, or need to write specifications for products or internal processes.
Ray Gallon is president and cofounder of the Transformation Society, which develops strategies for humanist digital transformation and organizational learning, and researches the theory and practice of smart pedagogies. He has over 50 years’ experience as a communicator, most recently in the technical content industries, including major companies such as IBM, Alcatel, and General Electric Health Care. He is a speaker on communications topics at conferences around the world.
Ray is a fellow of the Society for Technical Communication (STC), and has served as an STC international board member, past president of STC France, and president of The Information 4.0 consortium. He is a frequent speaker and keynoter on communications topics at conferences and seminars around the world. He has contributed to numerous books, journals, and magazines, and is the editor of The Language of Technical Communication (XML Press).
Earlier in his career, Ray was an award-winning radio producer and journalist.
Are you a technical writer who needs to write API software documentation? Do you wonder what you need to prepare and deliver to have high-quality API documentation and don’t know where to start?
If so, then this course is for you!
If you want your readers to easily find and retrieve your content, you need to invest in information architecture design and development. This will help you transform your content from simple “boring product documentation” into “intelligent information”.
Subscribe for the latest industry news, views and vacancies delivered directly to your inbox.
Firehead SAS
23 avenue de la Plaine Fleurie
38240 Meylan
France