Documentation Summit
About the Summit
Documentation is the key to the success of open source projects, from welcoming new users to onboarding new contributors with a clear contribution guide. Having good documentation is as important as having code. However, it is an area that is still overlooked by developers and contributors in the community. We need more awareness and skill sharing in building a welcoming community via accessible, well-organised and easy-to-understand documentation.
This will be a full-day summit including talks and panel sessions inviting leaders in documentation to share their experience in how to make good documentation, discussion about documentation tools such as sphinx, mkdocs, themes etc, what are the common mistakes and how to avoid them.
You are invited to join us in this documentation summit to share your experience with anything documentation-related
Target Audience
Documentation professionals like technical writers, open source leaders like maintainers, and anyone interested in contributing to documentation and accessibility of documentation. Anyone is welcomed, whether if they have contributed to open source before or not. Documentation issues could be good first issues for first-timers as well.
This summit is aimed at anyone who cares about or is involved in any aspect of open source documentation, such as, but not limited to, technical writers, developers, developer advocates, project maintainers and contributors, accessibility experts, documentation tooling developers, and documentation end-users.
Call for Proposal
If you would like to present a talk, lighting talk or interactive session, please submit your proposal with this form.
Deadline of Submission: 26th April 2024 23:59 UTC
Notification of acceptance: 3rd May 2024
Schedule
Throughout the day we have talks and discussion sessions. Participants are encouraged to bring up discussion topics at the unconference discussion and proposed lightning talk to present at the end of the summit.
Discussion topics and lightning talks can be proposed at the venue after the opening session.
| Time | Event |
|---|---|
| 10:00 - 10:25 | Welcoming to 1st ever Documentation Summit |
| 10:30 - 10:55 | [talk] An Introduction to Writing Approachable and Thorough Documentation - Kattni |
| 11:00 - 11:25 | [talk] Generic to Pythonic - Optimizing your Reference Documentation - Rohit Ganguly |
| 11:30 - 11:55 | [talk] Paint by Numbers: A Retrospective on the “NumPy Comics” and Under-Represented Skillsets in Documentation - Mars Lee |
| 12:00-13:00 | Lunch |
| 13:00 - 13:05 | [talk] Python Docs Editorial Board - Carol Willing and Ned Batchelder |
| 13:10 - 13:35 | [talk] Write Docs Devs Love: Ten Tricks To Level Up Your Tech Writing - Mason Egger |
| 13:40 - 14:40 | Unconference discussion |
| 14: 45 - 15:15 | Spontaneous Lightning Talk and Closing |