Explore the intricacies of documenting new projects in this 53-minute Open Documentation Hour session from the Technical Authors team at Canonical. Gain valuable insights into the principles and processes of effective documentation, including making your work easier from the start, understanding your audience and project scope, and dealing with legacy systems. Learn how to approach documentation for both blank slate projects and those with existing technical debt. Discover strategies to maintain simplicity and manageability in your documentation efforts from day one. Engage with the live Q&A session to address specific documentation challenges and best practices.
Overview
Syllabus
Welcome
Updates
Presentation
Documenting a new project
What exactly is a new project?
General principals to keep in mind
Principles: make your life easier, early
...to keep it bearable later
Preparation: know your people
Preparation: know your stuff
Preparation: know your project
Process: the blank slate
Process: legacy and technical debt
Keep things easy from day one
Questions
Taught by
Ubuntu OnAir
Related Courses
-
Documentation as Code: Benefits, Challenges, and Best Practices - June 7, 2024
-
Differences Between How-To and Tutorial Documentation - Open Documentation Hour
-
Encouraging Engineers to Write Their Own Documentation - Open Documentation Hour
-
Getting Hired as a Technical Author - Documentation Office Hours
