Plans for the Documentation Sprint

We have ten people coming to the documentation sprint next week, which is awesome! Thanks to everyone who could make it; particular thanks to WooThemes, Automattic, and 10up for sending their employees, and to those of you who are paying your own way. I and the rest of the docs team really appreciate your support.

Just some practical information, including the agenda and schedule.

What you will need

  • your laptop
  • a local installLocal Install A local install of WordPress is a way to create a staging environment by installing a LAMP or LEMP stack on your local computer. or other test site
  • an IRC client (we’ll all be logged in to #wordpress-sfd)
  • please familiarise yourself with the style and formatting guide
  • your brain

Food & Social Activities

We’re having our docs dinner together on Monday night at a restaurant near the hotel.

Tuesday night we can figure out what to do while we’re there.

Lunch isn’t provided by the venue but I’m told that there are lots of places around that we can get food. I’ll buy some munchies ahead of time.

Workshop

It’s the first time we’ve gotten together in person so I think doing a workshop will be a good idea. We’ll look at the frustrations around WordPress documentation and review the results of the recent Codex survey and Codex audit. After discussion we should have a list of tasks for improving WordPress documentation and a roadmap for ongoing improvements. We will also define our goals for the following 2.5 days and create teams to work on specific tasks.

Note: one of the summit action items was to create a Codex Roadmap – it would be great if we could produce this at the sprint.

Here’s the agenda. Note that it’s fairly fluid – I just wanted some sort of structure for the three days. I’ve added a few presentations which I will give on the first day on doc writing. I’ve also contact a few of the other attendees about doing short presentations. If anyone else would like to do one please feel free to – just keep it to 10-15 minutes.

Agenda

17th June 2013

9:00 – 12:00 Documentation Workshop

12:00 – 1:00 Lunch

1:00 – 1:15 – presentation from Siobhan about planning docs

1:15 – 2:30 Planning

In the teams, work on planning out the documentation that you’re going to create.

2:30 – 3:00 Break

3:20 – 3:30 presentation from Siobhan about writing docs

3:30 – 5:30 Writing!

5:30 – 5:45 Stand-up to review what we’ve done for the day

7pm – Dinner at Nada

18th June

9:30 – 9:45 Morning standup

9:45 – 1:00 Writing

1:00 – 2:00 Lunch

2:00 – 6:00

6:00 – 6:15pm Evening standup

19th June

9:30 – 9:45 Morning standup

9:45 – 1:00 Writing

1:00 – 1:30 Lunch

1:30 – 3:30 Writing

3:30 – 16:30 Wrap up and task list for future

17:00 – I’m off to the airport!

#sprint