Page MenuHomePhabricator
Create Task
Maniphest T281588

[Session] Better practices for technical documentation
Closed, DeclinedPublic
Actions

Description

Username or display name (will be displayed publicly):

SRodlund (WMF)

Categories/Tags/Keywords (up to 5):

Documentation

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:

TBA

Event Timeline

• srodlund created this task.Apr 30 2021, 4:15 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptApr 30 2021, 4:15 PM
• srodlund updated the task description. (Show Details)Apr 30 2021, 4:16 PM
taavi moved this task from Backlog to Session proposals on the Wikimedia-Hackathon-2021 board.Apr 30 2021, 6:21 PM
• srodlund claimed this task.May 6 2021, 1:41 PM
WMDE-Fisch awarded a token.May 7 2021, 1:01 PM
Lea_Lacroix_WMDE added subscribers: danshick-wmde, Lea_Lacroix_WMDE.May 10 2021, 7:03 AM

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 :)

waldyrious subscribed.May 10 2021, 2:49 PM
• srodlund added a comment.May 10 2021, 4:05 PM

@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?

Lea_Lacroix_WMDE added a comment.May 11 2021, 7:55 AM

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?

• srodlund added a comment.May 11 2021, 1:24 PM

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

Lea_Lacroix_WMDE closed this task as Resolved.May 11 2021, 2:00 PM

Yes, good idea :)

Aklapper changed the task status from Resolved to Declined.May 12 2021, 9:26 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits