Join the Community Team for yet another Documentation Editing sprint on August 6

After a successful documentation sprint on May 25 this year, I would like to announce that we are bringing back the Documentation Sprint for Community Team handbooks on August 6  (Friday). All are welcome to contribute to this initiative. This post contains everything you should know about the documentation sprint, along with details on how you can contribute!

What is a documentation editing sprint?

All day on August 6 (Friday), community contributors and deputiesDeputy Community Deputies are a team of people all over the world who review WordCamp and Meetup applications, interview lead organizers, and generally keep things moving at WordCamp Central. Find more about deputies in our Community Deputy Handbook. work together to audit and edit outdated pages in the Community team handbooks and any related documentation for the Community Team so that they provide accurate and up-to-date information for community members. Check out the original proposal for more details and context.

Please note: This documentation sprint is restricted to the community team handbook pages – we will not be working on the official wordpress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/ documentation as part of this sprint. However, if you wish to contribute to the wordpress.org documentation, please reach out to the documentation team (You can pingPing The act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.” them directly in the #docs channel). They could use all the help they can get!

What documents need editing?

All Community team handbook contents need auditing, reviewing, and updating. This includes (but is not limited to): 

Additionally, updating the following handbook pages will have the highest and most immediate impact: 

How do I participate in the documentation sprint?

Anyone can participate in this initiative! The team will keep track of edits in a Google Sheet. Please log all the changes you make in that sheet. The team will also coordinate together in the #community-team channel.

There are a few ways to contribute to the sprint:

  • Triage: Go through the list of documents, make a note of the pages that need updating (as well as the changes that need to be made), and add them to the tracking sheet.
  • Editing: Editing the documentation pages to keep them clear and up-to-date.
  • Adding new content: This could include adding Tuesday Trainings to handbooks, translating existing content to new languages, or updating our documentation to include resources on the new guidelines in-person events. Alternatively, if you feel that a new page on a specific topic needs to be added to the handbook, now would be an excellent time to contribute!

To track changes, copy the handbook contents over to a shared Google document, propose the changes over there, and link the document to the shared Google tracking Sheet.  Deputies will review and merge those changes later. 

Try your best to follow the docs style guide while creating content, as it helps maintain consistency. This is an all-day event, and there is also no time commitment. Try to spend as much time as possible on August 6 editing documents – even if you only have a few minutes. In short, you can contribute at your own pace, as per your convenience and bandwidth.

Every contribution, however small, is valuable!

What’s next, once the event is over? 

Community deputiesDeputy Community Deputies are a team of people all over the world who review WordCamp and Meetup applications, interview lead organizers, and generally keep things moving at WordCamp Central. Find more about deputies in our Community Deputy Handbook. will review the contributions and merge all the changes that were proposed. The Community team will publish a recap of this initiative requesting feedback from contributors. We also plan to organize regular docs sprints frequently so that our documentation pages stay updated. 

I warmly welcome you all once again to join us in this initiative and to help us improve our documentation. It will go a long way in supporting the WordPress community!

#documentation-sprint

#sprint

Proposal: A documentation editing sprint for the Community team

I won’t mince words here – several pages in the Make/Community handbook are outdated and need to be updated. With recent changes to our program – especially with the shift to online events, some documents have become redundant. Many other documents that are still relevant, have not been updated to incorporate the latest changes. In this background, our docs could benefit from a structured, pro-active approach to make sure that they stay current and accurate.

To achieve this goal, I propose a documentation editing sprint for the Community team!

What is a documentation editing sprint?

Community contributors and deputiesDeputy Community Deputies are a team of people all over the world who review WordCamp and Meetup applications, interview lead organizers, and generally keep things moving at WordCamp Central. Find more about deputies in our Community Deputy Handbook. work together to audit, and edit outdated documents in the Community team handbooks and any related documentation pages, so that they provide accurate and up-to-date information for our community members.

What are the documents that we will be editing?

We should audit, review, and edit the following documents in our Community team handbook:

Since the community team actively works on the Learn WordPress project, it would help to review and make changes to the Learn WordPress handbook as well – if we have the bandwidth.

When do we do it?

I propose that we test this out by organizing an initial sprint exactly two weeks later on May 25th – which is also known as the Towel Day (no points for guessing – I’m a Douglas Adams fan! 🙈). If the initial sprint goes well, we can consider organizing multiple sprints throughout the rest of the year. Community members can work on editing the documentation pages at their own convenience throughout the course of the day.

Who can participate/Who edits the docs?

This initiative is open to all! Many Community deputiesDeputy Community Deputies are a team of people all over the world who review WordCamp and Meetup applications, interview lead organizers, and generally keep things moving at WordCamp Central. Find more about deputies in our Community Deputy Handbook. have edit access to the Make/Community site, they can perhaps edit the documents directly. Other community already members can propose changes in a shared Google doc which can later be merged with the main document.

How do we do it?

It would help to keep track of all the documents and their changes in spreadsheets, or using collaboration tools such as TrelloTrello Project management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing.. Perhaps, before the sprint day, a few deputies can do a pre-event sweep to identify the docs that need to be edited, and encourage contributors to work on those selected documents? Contributors can use a shared Google sheet to update the status of the edits they made and the work they did. We can use the #community-team SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. channel to coordinate the efforts. The efforts can be spread out throughout the day so that folks can work at their own pace.

Following the event, we publish a recap post to share about the changes that were made during the sprint. If it is successful, we can probably repeat the event later and perhaps even consider organizing regular documentation editing sprints (either once per quarter or once every month).

Request for feedback

  • First of all, what do you think about this idea and the proposed format? Is this something the community team should carry out?
  • Do you know of any specific documents from our handbook that need edits? If so, please share them in the comments.
  • The biggest question: How do we track progress – both contributions from individual community members and changes made to the documents?

Please share your feedback by May 20th (Thursday).

#documentation-sprint #community-team