YoVDO

No Docs? No Problem! - From Zero to Full Documentation in Less Time than You Think

Offered By: linux.conf.au via YouTube

Tags

linux.conf.au Courses Software Development Courses Community Engagement Courses Continuous Integration Courses

Course Description

Overview

Save Big on Coursera Plus. 7,000+ courses at $160 off. Limited Time Only!
Discover practical strategies for rapidly developing comprehensive technical documentation for mature codebases in this 43-minute conference talk from linux.conf.au. Learn how to design documentation as an "alternative API," stage large projects in deployable parts, integrate with continuous integration environments, and implement effective team practices. Gain insights on improving system architecture and community involvement through parallel documentation development. Explore real-world lessons from the speaker's experience documenting the HarfBuzz library, covering topics such as top-down design, staging strategies, and practical tips for documentation teams.

Syllabus

Intro
The Takeaway
About Me
What is HBShape
Do you need documentation
Documentation as an API
Planning Phase
Documentation is monolithic
Target readers
Documentation collection
Documentation goals
Writing tips
Continuous integration
Voice consistency
External reviewers
No Docs
Testing
Publishing
Conclusion
Questions


Taught by

linux.conf.au

Related Courses

Modern & Contemporary American Poetry (“ModPo”)
University of Pennsylvania via Coursera
TechniCity
Ohio State University via Coursera
Inquiry Science Learning: Perspectives and Practices 1 - Science Leadership
Rice University via Coursera
EUROPA 2020: Regeneración urbana
Universitat Jaume I via Independent
International Women's Health & Human Rights
Stanford University via Stanford OpenEdx