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, May 22, 9am-5pm Pacific Time.
- Location: Online conference platform.
Your Project Here¶
Add your project via a PR on GitHub or mailing us! You can always reach out to us if you have any questions or concerns before signing up.
Open Web Docs¶
Open Web Docs was created to ensure the long-term health of web platform documentation independent of any single vendor or organization. It’s supported by various organizations and individuals, and employs technical writers who create and maintain open documentation for the web platform. At the moment we’re focused on maintaining and improving MDN Web Docs.
At the Writing Day we’ll be working on MDN Web Docs and we’d love you to join us. Here are some of the projects we’ll be working on:
- Content bug fixes: we’ll bring a list of issues that are suitable for first-time contributors to MDN.
- Adding missing sidebars: we have a number of pages (30-100) in the Web API reference with no sidebar or with the wrong sidebar. To fix this we need to add the right macro call at the start of the page.
- Writing some API overview pages: on MDN we have pages that provide an overview of a particular API. At a minimum, these need to list all the objects that make up the API and link to them.
The MDN content is maintained in Markdown in a GitHub repository: https://github.com/mdn/content, and updates are made as GitHub pull requests, so to get started, you’ll need a GitHub account.
However, we’ll start with a session for complete beginners about how to write a pull request for a GitHub repository.
We’ll be available to help you understand exactly what’s needed for all these tasks and to help work through any problems. We’re also really interested in understanding where people have problems contributing to MDN and how we can make it easier. So if you do join us for Writing Day, please tell us about it - what worked and what didn’t, what was easy and what wasn’t - so we can improve the experience for contributors.
Solid is an open-source front-end framework for building web apps. We’ve been getting more use and attention than ever, so we formed a docs team to rework and rewrite our documentation to be as beginner-friendly and usable as possible.
Solid is the perfect project to get involved in if you’re interested in open-source, web development, or just want to see what outside-the-box documentation ideas we have in store!
We’re excited to meet you. Here’s what we’re up to and how you can help:
- We have an existing docs site, and a new one we’ve just started. Our goal is to restructure and rewrite the content that’s on our existing docs site, which consists of a set of guides, an interactive tutorial, and an API reference page. We were thinking of following the Diataxis model for the new site, but we’d love your feedback on structuring our documentation.
- If you see something on our new docs site that you want to change and you’re familiar with GitHub, feel free to directly make a PR by clicking the Edit button at the bottom of a page.
- We’re looking for contributors! Whether you have no experience with web development or already use the framework, we’d love for you to join our open-source docs team and help make the #1 satisfaction-rated framework even more satisfying!
The Good Docs Project¶
The Good Docs Project educates and empowers people to create high-quality documentation by providing them with resources, best practices, and tools to enhance their documentation in open source and beyond. We have a fun, supportive, and encouraging community where we geek out about tech writing. First and foremost, we create documentation templates with supporting guides. We also engage in many other initiatives around docs advocacy, docs education and docs tooling.
During writing day, we’d love to introduce you to a range of aspects to our project:
- Kickoff: introduction to The Good Docs Project (9:00 - 9:50 PT) - Get to know us! Join us to hear a general overview of our community.
- Identifying content types for templates (10:00 - 10:50 PT) - Creating templates is one of our main projects. By participating in our template brainstorming workshop, we can identify what templates we should try to provide to our users and help us build a roadmap for our future template work.
- Docs advocacy and education (11:00 - 11:50 PT) - We publish deep thought theory, best practices and ideas about documentation within our blog. Come help us brainstorm future topics, and maybe bullet out what should be covered.
- The Chronologue (1:00 - 1:50 PT) - We’re creating our own fake project that can be used to generate documentation examples. Come help us build both the world and the documentation for The Chronologue tool, a fictional telescope that can view astronomical events at any moment in time.
- The Good Docs Project Q&A (2:15 - 2:50 PT) - Come ask us anything about what it’s really like contributing to The Good Docs Project.
- Business case for docs (3:00 PT - 3:50 PT) - We want the perfect pitch to invent in docs. This is an early stage project. Come help us in the brainstorming and researching phase of the project.
- API reference template review ( 4:00 - 4:50 PT) - Our API Reference Template is draft complete. Join this session to assist us in reviewing and polishing an almost complete template.
Write the Docs¶
Write the Docs is looking for volunteers to help us update some of our existing content. The particular volunteers for this table are focusing on the Meetup content, including adding information on the Quorum meetups.
The issues are great starting points:
Adapt the Quorum virtual event guide for general meetup use, pages include:
- Organizing a Quorum Meetup
- Meetup roles
- Zoom coordinator guide
- Running a tech check
- How can presenters get in touch with organizers (older ticket that applies to this topic)
There are other existing issues that folks can choose to work on outside of meetup content:
- Convert guide to Markdown
- Create a contributing guide Write the Docs github
- Format change suggestion for Release Notes section <https://github.com/writethedocs/www/issues/1505>
During the conference¶
Check out the Writing Day Cheat Sheet for a quick reference that you can use during the conference to make the most out of Writing Day.