Class Central is learner-supported. When you buy through links on our site, we may earn an affiliate commission.

YouTube

Documenting a New Project - Best Practices and Principles

Ubuntu OnAir via YouTube

Overview

Save Big on Coursera Plus. 7,000+ courses at $160 off. Limited Time Only!
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.

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

Reviews

Start your review of Documenting a New Project - Best Practices and Principles

Never Stop Learning.

Get personalized course recommendations, track subjects and courses with reminders, and more.

Someone learning on their laptop while sitting on the floor.