Upgrade to Pro — share decks privately, control downloads, hide ads and more …

2020 - The hero of the story: Transforming documentation with user stories

UX Y'all
September 25, 2020

2020 - The hero of the story: Transforming documentation with user stories

UX Y'all 2020 Session with Ingrid Towey

UX Y'all

September 25, 2020
Tweet

More Decks by UX Y'all

Other Decks in Design

Transcript

  1. WriteUX @IngridTowey The Hero of the Story Ingrid Towey Principal

    Technical Editor, Writing Coach 1 Transforming your documentation with user stories
  2. 2

  3. 3

  4. 6 We are, as a species, addicted to story. Even

    when the body goes to sleep, the mind stays up all night, telling itself stories. “” The Storytelling Animal: How Stories Make Us Human, Jonathan Gottschall
  5. 7

  6. 8

  7. 9

  8. 10

  9. 12 What are we going to do today? 1 Learn

    about user personas 2 Learn about user stories 3 Show how a user story is used to write content 4 Write your own user stories 5 Write a procedure from a user story
  10. 14

  11. What are user personas? 15 Archetypal users These profiles are

    developed by user experience or marketing. Typical behavior patterns, skills, attitudes, and background info The profiles present these users as if they are real people with personal details. From: Red Hat User Experience Design Cyril SENIOR DEVELOPER
  12. Some OpenShift personas at a high level Platform Generalist Platform

    Builder Platform Manager I design and deliver the cloud platform for hand off to the client or operations team I continuously deliver the best platform for critical business applications I influence the platform through strategic initiatives, planning, and relationships, but I still can get hands-on User personas contribute to a delightful user experience
  13. 6 months experience Entry-level skills in software design and testing;

    Agile Knows Java, C, C++, HTML5 and CSS Uses IntelliJ IDE Designing, developing, and modifying efficient code modules that are assigned to him by his team lead. Becoming a better programmer by absorbing information however he can: reading books, blogs and tech websites, asking questions to more senior-level colleagues, and trying new technologies that he’s discovered and been told about by his team lead. Never holding his team back from meeting a deadline or completing a deliverable. “Once I graduated from college, I thought I knew everything about programming. But I’ve since learned that it involves so much more than writing code. I needed to learn to communicate effectively with my team and be flexible when the development process breaks down. Most of all, I needed to learn how to work quickly while under pressure to deliver!” GOALS Lacking experience collaborating with a large team doing enterprise software development, as well as learning how to get the environment set up correctly, John often has questions that he has difficulty getting answers to. It’s difficult to see how his code modules fit in with the rest of the code that the team is creating - John feels like he’s looking through a keyhole to view the universe. I am under extreme pressure to deliver and spend too much time managing content and I never really know how my team or myself are doing, in terms of progress. John is eager to prove his value to his manager and the rest of the development team, so he gets to his desk at 7:00 AM, at least an hour before the next person arrives at the office. The first thing he does is re-examines the code review comments from the previous day, making sure he’s done things correctly. After that, he checks out a few tech blogs and completes a couple of modules on his online .NET training course. When he can steal some time from his team lead, he asks her a few questions about the product architecture and then asks for some technical background on the stories he’ll be likely be taking in the next sprint. John then attends the daily stand-up, and once that’s over, returns to his desk to continue working on his modules for several hours straight. The day ends with a brief check-in meeting with his manager, who wants to make sure John is able to carry out his work without problems and is adjusting well to his responsibilities. PAIN POINTS DAY IN THE LIFE... More info... John Junior Developer Application & Service implementation B.S. in Computer Science BACKGROUND
  14. What is a user story? As a _____, I need/want

    to ______, so that ______. 19 Who (Persona) What Why As a system administrator I want to upgrade the cluster while the system is running, so that my company doesn’t have any downtime. As a student I want to buy my books before my classes start, so that I don’t start the semester behind.
  15. Bad user story 20 Who (Persona) What Why As a

    grandparent on Facebook I want to send a private message, so that I can have a private conversation with one or multiple people, close friends and acquaintances, and save all those messages for as long as I want.
  16. Improved user story 21 Who (Persona) What Why As a

    grandparent on Facebook I want to send a private message, so that my grandchild can confide in me about problems in school.
  17. 23 As a system administrator, I want to go to

    the OpenStack dashboard, so that I can read the console. Is this a good user story? (Vote)
  18. 24 As a warehouse worker, I need to create, edit,

    and save a list of items, so that I can save a copy, print it, email it to others, use it as a checklist, and then edit it again to reuse it. How about this one? (Vote)
  19. 25 As a music listener, I want to compile a

    playlist of specific songs on my app, so that I can listen to them when I’m in the right mood. How about this user story? (Vote)
  20. 28 • OpenShift allows system administrators and developers to manage

    cloud workloads and containers. • A cluster is a set of machines that runs and manages containers. User stories for Red Hat OpenShift
  21. How we use user stories to create documentation 29 Who

    (Persona) What Why As a cluster administrator I want to review of the status of my cluster, so that I can find the problem areas.
  22. How we use user stories to create documentation 30 Who

    (Persona) What Why As a cluster administrator I want to know how to collect relevant OpenShift debug data efficiently, so that we can diagnose the problem quickly. As a cluster administrator I want to review of the status of my cluster, so that I can find the problem areas.
  23. How we use user stories to create documentation 31 Who

    (Persona) What Why As a cluster administrator I want to know how to collect relevant OpenShift debug data efficiently, so that we can diagnose the problem quickly. As a cluster administrator I want to review of the status of my cluster, so that I can find the problem areas. As a cluster administrator I want to resolve OpenShift issues quickly, so that their impact on our business is minimized.
  24. 32 As a cluster administrator, I want to know how

    to collect relevant debug data efficiently, so that we can diagnose the problem quickly. User story → Procedures
  25. 34

  26. Agile EPIC 35 User story User story User story User

    story User story User story User story User story User story
  27. 37 Exercise: Write your own user stories 15 minutes 1.

    When we pause this session, go to the Lounge. We have tables set up for you already. 2. Go to the table that corresponds with the first letter of your last name. If there are too many people at that table, pick one that needs people. If your table is just you, join a table that needs people. Leave a seat open at each table. ◦ We have a Google doc with complete instructions and assignments per table number. You will be writing user stories for situations like this: ▪ Uber ▪ A computer game ▪ A shop that sells custom T-shirts ▪ An Etsy shop 3. Think of a persona for your system (for example, a computer game could have these personas: a novice gamer, an experienced gamer who owns and plays several games and systems, and more). 4. Write at least 3 user stories. Use at least 2 different personas. 5. Report back to the group.
  28. 39 Exercise: Write a procedure from a user story System:

    Persona: Abstract: Before you start • How to 1.
  29. 40 Exercise: Write a procedure from a user story System:

    Uber Persona: International traveler on a budget User story: As a budget traveler, I want to share my Uber ride with other people, so that I don’t have to spend so much money to get to my destination. Sharing a ride on Uber UberPool lets you share rides with other people to save money. But it may take a little longer. Before you start • App installed on the phone • Credit card How to 1. Open the Uber app, and selec Get a ride. 2. Tap the UberPool ride option. 3. Look for your car number.
  30. ❖ Humans think in stories. We are compelled to tell

    them. ❖ If we wrap stories around our technology, we can create more humane technology that serves us rather than ruling us. ❖ Our readers, customers, and users are the heroes of their own stories. They may not look like Batman or Wonder Woman. They may look just like you and me. But we need to see the hero in all of them and in us. 41 We are all heroes
  31. CONFIDENTIAL Designator linkedin.com/company/red-hat youtube.com/user/RedHatVideos facebook.com/redhatinc twitter.com/RedHat Red Hat is the

    world’s leading provider of enterprise open source software solutions. Award-winning support, training, and consulting services make Red Hat a trusted adviser to the Fortune 500. Thank you 43