Each year we run an event called the Writing Day during the conference. This event is modeled after the concept of sprints, which are common in open-source conferences. The main premise is to get a bunch of interesting people in a room together and have them work towards shared goals.
To make the most out of the Writing Day, we recommend that you either come with a project, or be ready and willing to contribute to someone else’s project.
Here are some examples of projects that you might want to work on:
- Open source software documentation
- General documentation writing
- Best practices manual (For your company, or the world)
- Blog posts
- Tips and tricks
- Great works of fiction
- Love letters
- The Documentarian Manifesto
You get the idea.
All this adds up to a room full of smart people sharing your problems, your passion, and your goals. So be ready to learn some new things and to teach others what you know.
Even if you feel as though you don’t know that much, we know you have a lot to offer. Come surprise yourself with how much you can share.
Documenting a new project?¶
Check out our beginners guide to writing documentation. This should help you get started, and give you some ideas for how you can contribute to a project that you love.
Please bring a computer or some other mechanism with which to create written words. We’ll be creating and editing content, so make sure that you have the tools you need to contribute.
- Date & Time: Sunday, August August 9, 9am-6pm, with the conference opening reception in the same space from 17:00.
- Location: Online, platform to be determined. We will be in the main ballroom.
Your Project Here¶
The Good Docs Project¶
You’ve just been asked by your team to create documentation for your project. But what kind of document should you create? (An FAQ? A README?) What is supposed to be in it? How do you begin?
The Good Docs Project can help.
We’re working on a set of templates to make it easier to write documentation by suggesting the content needed to create the minimum viable set of documentation for your project. Visit our table if you have new documentation to create, or if you want to try your existing docs against our checklists, or if you just want to talk about templates.