Teaching & Learning: Framing Documentation as a Training Tool

We consider anything from API libraries to FAQs to be documentation. Documentation, at its core, is a teaching aid: We use it to learn what we didn't know before.  

Documentation as training

Have you ever struggled to satisfy your audience when writing documentation?  Do you have a hard time balancing between conceptual clarity and stepwise recipe? Join us in a discussion about 3 very different types of readers, each with her own specialized needs.


In this talk, the speaker will draw on lessons from research in the cognitive sciences, as well as over a decade of teaching experience to introduce the audience to 3 distinctly different types of documentation that will serve the needs of a diverse audience.  


Speaker

Sherif Abushadi

Lead Teacher & Facilitator, Dev Bootcamp SF

[masked]

[masked]




About the speaker

A graduate of Queen's University, Kingston, Ontario with a Bachelor of Science in Mechanical Engineering, Sherif Abushadi has been designing and developing software professionally for over 15 years in the US, Canada and abroad.  He has played a leading technical role for over 10 years as a co-founder, lead architect, consultant, corporate trainer and agile coach.  In these roles, Sherif taught thousands of professionals across hundreds of companies how to solve complex business problems using software and executable documentation.  His focus on teamwork, creativity and organizational learning has made an impact on several Fortune 100 companies including Verizon, Caterpillar and Nationwide Insurance as well as a number of government agencies including the Federal Aviation Administration and the Departments of Labor, Education and Homeland Security.

Join or login to comment.

  • sherif

    Folks,

    That was a ton of fun last night, thank you for having me. Ruth! Thank you.

    Here's the follow up material (note there was a mixup with my original prezi link so there's an updated one here)

    http://bit.ly/writethedocs-meetup-more

    Enjoy!

    Sherif

    September 13, 2013

  • Richard M.

    It was a stimulating meeting that made me think hard about what I know about documentation and training.

    2 · September 12, 2013

  • Jose P.

    So sorry, but finally I won't make it. It looks like I will be working late today.
    I hope the event goes great and look forward to the feedback!

    September 12, 2013

  • Juli F.

    Bummed I can no longer make this; forgot I have a flight that morning. Looking forward to the next one, have fun all!

    September 11, 2013

    • Ruth B.

      That's okay, just win big for me in Vegas :)

      September 12, 2013

  • Jose P.

    Oh, my beloved Barcelona... Lucky man, Kyros :)
    Looking forward to the event tonight!

    September 12, 2013

  • jerrysarcastic

    I am sorry to say I cannot make it tomorrow; I sprained my ankle (plus a bonus hairline fracture) and won't be able to manage driving or taking transportation up from San Jose. Hope to meet you all and geek out about docs at the next event!

    September 11, 2013

    • Ruth B.

      Bummer - take it easy. See you at the next one!

      September 12, 2013

  • Kyros

    Last minute trip for work, so I'm not going to be able to make it this month. But bonus, I get to go to Barcelona!

    September 12, 2013

    • Ruth B.

      What?! Lucky. Have a blast.

      September 12, 2013

  • Megan S.

    Sorry, I have to miss this one! I'll look forward to more events from this group in the future.

    September 9, 2013

    • Ruth B.

      Rats! Hopefully we'll catch you next time.

      September 10, 2013

  • Ruth B.

    Hi all!

    Just FYI, you'll enter on the side street at 90 Sherman St, SF. It's just around the corner, off Harrison between 6th and 7th St.

    You can enter from the door under the Atlassian Dev Den sign (https://www.atlassian.com/devden), grab some pizza and refreshments, and settle in.

    Looking forward to seeing you all there! Feel free to bring friends and colleagues, just have them RSVP so we can order enough food to get 'em fed.

    1 · September 4, 2013

  • A former member
    A former member

    I don't get to SoMa very often. Is there parking at this place, or should I take BART?

    August 10, 2013

    • Lydia S.

      I've *never* had a problem finding street parking for any event at Atlassian.

      August 12, 2013

    • Nick W.

      There's also several surface lots nearby, Google Maps can help find them, most of them are under I-80 Bay Bridge approach

      August 28, 2013

People in this
Meetup are also in:

Imagine having a community behind you

Get started Learn more
Henry

I decided to start Reno Motorcycle Riders Group because I wanted to be part of a group of people who enjoyed my passion... I was excited and nervous. Our group has grown by leaps and bounds. I never thought it would be this big.

Henry, started Reno Motorcycle Riders

Sign up

Meetup members, Log in

By clicking "Sign up" or "Sign up using Facebook", you confirm that you accept our Terms of Service & Privacy Policy