Page MenuHomePhabricator

[Session] Better practices for technical documentation
Closed, DeclinedPublic


Username or display name (will be displayed publicly):

SRodlund (WMF)

Categories/Tags/Keywords (up to 5):


Session type (select one):

  • Presentation (including Q/A) - 25 mins
  • Discussion (including Q/A) - 55 mins
  • Workshop (including Q/A) - 55 mins
  • Lightning talk - 5 mins

Venue (select one):

  • I would like to be on the main track
  • I wouldn't mind being on the main track
  • I need a Jitsi room for the session

When are you available to have the session?

22 May, 4 PM UTC - 11 PM UTC (This is when I'm available to be online. However, I can record the presentation ahead of time for broadcast at any time, if that will help).

Session Details

Short description of the session (~150 words):

Creating and improving technical documentation is often a matter of progress, not perfection! This presentation will cover some basic practices you can follow to start creating and improving technical documentation right away. I'll also share some resources that you can use to improve your documentation skills.

This is for anyone who is interested in improving technical documentation on Wikimedia projects.

What will participants get out of this session? (~50 words)

Participants will leave the session with a set of practices and resources that they can use to create and improve technical documentation.

(Optional) Additional resources:


Event Timeline

Thanks for offering this session :)
My dear colleague @danshick-wmde cannot attend the hackathon but recorded this introduction to documentation (22min). Do you think we could somehow combine both? Like maybe show the recording before your session, and then you can add more things live? Let me know what you think :)

@Lea_Lacroix_WMDE Thanks for sharing! This is a really good presentation @danshick-wmde!

My proposal would be that instead of me making a brand new presentation about best practices that we use Dan's and that we schedule the open docs Q & A session for before or after the talk.

I could start the Q & A by pointing out resources folks can use and raise open questions from the talk. Would this work?

Here's what we can do: we display Dan's video in the main program, and directly after we follow up with the Q&A in the open room, so people can jump there to chat with you. This would means that this session "Better practices for technical documentation" wouldn't exist as such. Is that OK for you?

@Lea_Lacroix_WMDE This is a perfect plan! :-) Should we close this task?

Aklapper changed the task status from Resolved to Declined.May 12 2021, 9:26 AM