Learn open-source software documentation skills with Canonical
The Open Documentation Academy combines Canonical’s documentation team with documentation newcomers, experts, and those in-between, to help us all improve documentation practice and become better writers.
If you’re a newcomer, we can provide help, advice, mentorship, and a hundred different tasks to get started on. If you’re an expert, we want to create a place to share knowledge, a place to get involved with new developments, and somewhere you can ask for help on your own projects.
A key aim of this initiative is to help lower the barrier into successful open-source software contribution, by making documentation into the gateway.
What you’ll get out of it
Real experience, real skills, real discipline: Open-source products in the Canonical/Ubuntu industry are highly-respected and used by millions of people. Standards for contributions are high. You’ll have a chance to contribute to prestigious projects, and acquire the skills to take part in the development of world-class software.
Structured support: The Open Documentation Academy will include a structured programme of support and development for serious participants, taking them from their first steps to having the confidence to lead their own documentation initiatives.
Recognition: Your contributions will speak for themselves, but we’ll vouch for you too. Participants who complete our programme will receive certification from Canonical.
What we offer
Mentoring: You are not alone. Regardless of whether you’re writing your first document, or editing your hundredth, we’re here to help. Our 1:1 mentorship can help you through your first contributions, provide advice on approaches, and help you build your confidence.
Guided contributions: Help us identify gaps, nominate solutions, and propose documentation of your own. We curate tasks across a variety of different open source projects. Choose a task you’re interested in, at a level you’re comfortable with, and make a contribution. Research. Write. Commit. Fill blanks in your resume and colour your GitHub Activity tracker golden.
Community: Through our forum and communication channels, you can directly interact with documentation teams and co-conspirators across the globe. We want our community to be friendly, inclusive and always supremely approachable, in accordance with the Ubuntu Code of Conduct.
What you will do
- Participate in our forum here, and join our Office Hours discussions
- Reach out to our team of mentors, let them know you’re interested
- Find a project that excites you, and make your first contributions
Activities
Weekly Office Hours: Every Friday, join us for interactive discussions about tricky documentation problems and help us to improve documents together. This is the place to solicit feedback from the team, and to share your docs struggles and accomplishments. Everyone is welcome, whether you participate or prefer to listen. See Documentation office hours for our schedule.
Events: We’re planning to host both online and in-person events enabling us all to target specific objectives together. These targets may include improving sets of documentation, creating guides and tutorials, or just discussing and agreeing on a style guide.
Stay in touch
If you’d like to ask us questions outside of our public forums, feel free to email us at docsacademy@canonical.com.
Subscribe to our calendar: Documentation events
Participate in our discussion forum here on the Ubuntu Community Hub:
https://discourse.ubuntu.com/c/open-documentation-academy.
Chat to us on Matrix at https://matrix.to/#/#documentation:ubuntu.com.
Follow our progress online throughMastodon:
https://fosstodon.org/@CanonicalDocumentation