Writing for Developers - Take Your Project Docs to the Next Level
Offered By: CNCF [Cloud Native Computing Foundation] via YouTube
Course Description
Overview
Discover how to elevate your project documentation in this 23-minute conference talk by Celeste Horgan from CNCF. Learn essential strategies for effective technical writing, including determining content priorities, adopting a user-centric approach, and crafting compelling documentation. Follow along as Horgan demonstrates how to enhance existing documentation for a CNCF project and create new feature documentation from scratch. Gain insights into the importance of well-structured documentation in open-source projects and explore concepts such as user goals, task topics, and reference topics. Whether you're a developer looking to improve your writing skills or considering a career in technical writing, this talk provides valuable guidance on creating documentation that truly supports and engages your project's community.
Syllabus
Introduction
Call to Arms
Heroes Journey
Little Red Riding Hood
User Goals
Common User Goals
Hero Journey
Technical Writing
Concepts
Task Topics
Reference Topics
Heros Journey
Conclusion
Taught by
CNCF [Cloud Native Computing Foundation]
Related Courses
User Experience for the WebOpen2Study Writing READMEs
Udacity Introduction to Research
Indian Institute of Technology Madras via Swayam Technical Writing
Moscow Institute of Physics and Technology via Coursera Research Writing
Indian Institute of Technology, Kharagpur via Swayam