The Seattle WP Meetup’s next monthly WordPress Docs Sprint is coming up on Saturday, November 1st.
We need all experience levels – this isn’t just for coders. We need writers, screenshot-takers, editors, readers, and of course, developers. If you show up, we’ll find a way you can help.
What if you’re not in the Seattle/Tacoma area?
We’ll use Slack for team communication while we’re at the meetup, so if you’re joining from another state, country, or planet, you can participate as long as you’ve got a good internet connection.
If you don’t already have a Slack account, go to https://make.wordpress.org/chat/ and signup for an account. Once you log in, join us in the #docs channel.
How long are the Contributor Meetups?
From 10am – 2pm (18:00 – 22:00 UTC).
How do I join you?
- Show up in person or on Slack in #docs
- You can join the Seattle WordPress Meetup on Meetup.com (optional)
- RSVP for meetups that interest you and ask any questions you have
- We’ll help you get started contributing to Docs.
Howdy WordCamp Sofia Contributors!
Thanks a bunch for helping with WordPress documentation – we all really appreciate your help!
We’ve been focusing a lot on the Theme Developer Handbook and Plugin Developer Handbook, which both need a good deal of work.
For most people, the toughest roadblock to contributing is just getting started, so hopefully this will help.
Where to Go
The jumping off point for all docs-related efforts is: make.wordpress.org/docs/ – In the sidebar, you’ll see links to the Handbooks along with the Spreadsheets we use to track their progress.
- The Theme Developer Handbook is at: http://bit.ly/WPThemeHB
- . . . and the spreadsheet that we use to track Theme Developer Handbook progress is at: http://bit.ly/WPThemeHB_Content
- The Plugin Developer Handbook is at: http://bit.ly/WPPluginHB
- . . . and the spreadsheet that we use to track Plugin Developer Handbook progress is at: http://bit.ly/WPPluginHB_Content
- The IRC channel we use is at #wordpress-sfd on Freenode.
- This is a great place to ask questions, post links to docs for review, and cheer each-other on.
If you haven’t already, you’ll want to:
- Read the Handbook Style Guide
- Review the Handbook Tutorial Template
- Find a topic in the Theme or Plugin developer spreadsheet that interests you
- Check the Needs column of the spreadsheet to see if there are specific things that are needed in this document
- Add your name to the Responsible column in the spreadsheet
- Write or edit in HTML or Markdown and give it to Mario Peshev or email it over to me at eric [at] ivycat.com and we’ll post for you.
What if I’m not a Writer?
If you’re not comfortable writing or editing, you can also help by:
- Creating code snippets for examples
- Taking relevant screenshots
- Reading existing documentation and making comments regarding improvements
If you’re completely overwhelmed and not sure where to start, you might start by reading through the Handbook and, when you’ve got questions, find missing content, or see improvements, please feel free to work on the document, or make comments in that document’s comment section.
I’m here to help in any way I can, so feel free to ping me (@sewmyheadon) or Mario (@no_fear_inc), or post to the #wordpress-sfd IRC channel if you have any questions.
Thanks again and have a great WordCamp!
The Seattle WordPress Meetup is holding monthly WordPress Docs Improvement Meetups at a local coffee shop. So far, around 6 – 8 people attend each meetup, and the group has worked on docs in the Codex, Handbooks, and Function Reference.
The Docs Team would love to see other WordPress Meetups and local WordPress groups hold their own Documentation Meetups. Of course, Docs can use all the help it can get.
Things to keep in mind when organizing a Docs Meetup
Your location needs good internet access and power outlets. Duh, right? Great coffee also helps.
Figure out what to work on in advance. The hardest thing about contributing to these meetups is simply figuring out what to work on. So, as an organizer, prepare in advance by finding a handful of specific things that the group can work on. Keep it small and manageable. You can touch base with one of the Handbook editors, Docs Team Members, @hanni or @siobhan or @sewmyheadon to help make your list. There’s always plenty to do, but some things need quicker attention.
Publicize it. Ask people to contribute and encourage participation of all user levels. You don’t have to be a developer or designer to contribute. There are plenty of things you can do to help including:
- Screenshots – we need folks to take, and edit, screenshots to augment written documentation
- Examples & Code Snippets – need formatted code snippets and examples
- Editing / Proofreading / QA
- Transcribing video to text
- Developer support – non-devs need coders to help clarify functions, hooks & filters.
Post pre-meetup instructions. Before your meetup date, make sure to post some pre-meetup instructions so new contributors can be prepared when they come. Here’s an example of a Docs Improvement post from the Seattle WP Meetup site. At minimum, you’ll want to make sure people have reviewed the
Prepare to be a helper. Organizers should expect to spend about 30 to 50% of their time at the Meetups just helping others get situated, reviewing other’s docs, answering questions, etc.
Be okay with slow progress. Writing docs isn’t always a quick task, in fact, it’s usually the opposite. It’s a win if you can complete one or two documents in one 4 – 6 hour Meetup.
Join the #wordpress-sfd IRC chat room. During Docs Meetups, we encourage folks to login to IRC so they can ask questions, post progress, request docs reviews, and generally help out.
Be encouraging. Face it, writing docs can be relatively thankless and sometimes tedious work, so make sure to be positive, thank people for their participation, and be encouraging. The sooner someone feels like they’re contributing and their work is appreciated, the more likely they are to continue helping.
- Have fun.
If you’d like to participate in any of the already-scheduled Docs Improvement Meetups in-person in Seattle or virtually via IRC, here’s when we’re meeting:
- Saturday, September 21 (10am – 4pm PDT / 5pm – 11pm UTC)
- Sunday, October 20 (10am – 4pm PDT / 5pm – 11pm UTC)
- Saturday, November 16 (10am – 4pm PST / 6pm – 12pm UTC)
- Saturday, December 14 (10am – 4pm PST / 6pm – 12pm UTC)
Hope to see you there!
@westi shared this article on writing docs with me: http://stevelosh.com/blog/2013/09/teach-dont-tell/ It’s a great read and very relevant for what we’re doing on dev.wp.org. I recommend you all read it 🙂