Write the Docs
Write the Docs
  • Video 60
  • Views 119 017
Lana Brindley - More than words: Reviewing and updating your information architecture
Presented at Write the Docs Prague virtual conference, October 2021.

Check out the full list of speakers and talks:
www.writethedocs.org/conf/prague/2021/speakers/

Visit our community website to find out more about our events:
www.writethedocs.org/
Views: 398

Video

[Lightning Talk] Coley Woyak - New, first, & only
Views 983 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Visit our community website to find out more about our events: www.writethedocs.org/
Kat Stoica Ostenfeld - How I use applied linguistics to be a better technical writer
Views 2013 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Check out the full list of speakers and talks: www.writethedocs.org/conf/prague/2021/speakers/ Visit our community website to find out more about our events: www.writethedocs.org/
Anita Diamond - Cognitive Ergonomics in Technical Writing - Lessons from the Field
Views 1753 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Check out the full list of speakers and talks: www.writethedocs.org/conf/prague/2021/speakers/ Visit our community website to find out more about our events: www.writethedocs.org/
Felicity Brand - How to write a book for (and with) an open source community
Views 973 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Check out the full list of speakers and talks: www.writethedocs.org/conf/prague/2021/speakers/ Visit our community website to find out more about our events: www.writethedocs.org/
Mikey Ariel - Introduction to Write the Docs Prague 2021
Views 3213 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Visit our community website to find out more about our events: www.writethedocs.org/
[Lightning Talk] Swapnil Ogale - The five people you meet in documentation
Views 1473 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Visit our community website to find out more about our events: www.writethedocs.org/
[Lightning Talk] Emily Axel - Process Recordings: Documenting Social Work Conversations
Views 803 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Visit our community website to find out more about our events: www.writethedocs.org/
[Lightning Talk] Abi Sutherland - The best tech writing you’ve never seen
Views 2493 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Visit our community website to find out more about our events: www.writethedocs.org/
Anna Korinna Németh Szabó - Alchemy in Adversity
Views 923 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Check out the full list of speakers and talks: www.writethedocs.org/conf/prague/2021/speakers/ Visit our community website to find out more about our events: www.writethedocs.org/
Fabrizio Ferri Benedetti - When documenting is designing
Views 3493 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Check out the full list of speakers and talks: www.writethedocs.org/conf/prague/2021/speakers/ Visit our community website to find out more about our events: www.writethedocs.org/
Jenn Leaver - Docs leadership: How to become a stronger leader for your team
Views 3463 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Check out the full list of speakers and talks: www.writethedocs.org/conf/prague/2021/speakers/ Visit our community website to find out more about our events: www.writethedocs.org/
Kate Santo - From travel content to technical content: my journey
Views 723 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Check out the full list of speakers and talks: www.writethedocs.org/conf/prague/2021/speakers/ Visit our community website to find out more about our events: www.writethedocs.org/
Victor Sluiter - Adventures in setting up a knowledge system for a research group
Views 1373 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Check out the full list of speakers and talks: www.writethedocs.org/conf/prague/2021/speakers/ Visit our community website to find out more about our events: www.writethedocs.org/
[Lightning Talk] Tony Ibbs - Apostrophe - a story of naming
Views 643 months ago
Presented at Write the Docs Prague virtual conference, October 2021. Visit our community website to find out more about our events: www.writethedocs.org/
[Lightning Talk] Qian Lu - Design thinking is in tech writing all along
Views 893 months ago
[Lightning Talk] Qian Lu - Design thinking is in tech writing all along
[Lightning Talk] Bart Buerman - Bike the Docs
Views 643 months ago
[Lightning Talk] Bart Buerman - Bike the Docs
[Lightning Talk] Eugene Titerman - Docs as GUI
Views 1703 months ago
[Lightning Talk] Eugene Titerman - Docs as GUI
Lukas Reussner - Hitchhiker's Guide to Documentation Tools and Processes
Views 3413 months ago
Lukas Reussner - Hitchhiker's Guide to Documentation Tools and Processes
Karen Sawrey - Hustling for Fun and Profit as a Technical Writer: A Freelancing Starter Kit
Views 1473 months ago
Karen Sawrey - Hustling for Fun and Profit as a Technical Writer: A Freelancing Starter Kit
Kevin Hwang - Customer Feedback is the Fuel in our Engine
Views 1453 months ago
Kevin Hwang - Customer Feedback is the Fuel in our Engine
Ryan Macklin - So you need to give bad news to users…
Views 2363 months ago
Ryan Macklin - So you need to give bad news to users…
[Lightning Talk] Ingrid Towey - Turning cooperation into collaboration: A UX writing case history
Views 1808 months ago
[Lightning Talk] Ingrid Towey - Turning cooperation into collaboration: A UX writing case history
Ines Stefanovic - Is Tech Writer a Tester, and Vice Versa, Is Tester a Tech Writer?
Views 2678 months ago
Ines Stefanovic - Is Tech Writer a Tester, and Vice Versa, Is Tester a Tech Writer?
Swapnil Ogale - Putting the “tech” in technical writer
Views 8768 months ago
Swapnil Ogale - Putting the “tech” in technical writer
[Lightning Talk] Kathryn Elliott - Content Experience Checklist
Views 1368 months ago
[Lightning Talk] Kathryn Elliott - Content Experience Checklist
[Lightning Talk] Renée Carignan Schaaf - Why Docs Folks Make Awesome ERG Advocates
Views 908 months ago
[Lightning Talk] Renée Carignan Schaaf - Why Docs Folks Make Awesome ERG Advocates
Paris Buttfield-Addison - The Secret History of Libraries
Views 2198 months ago
Paris Buttfield-Addison - The Secret History of Libraries
Katherine Karaus - Invisible influence: the documentation behind UX copy
Views 4578 months ago
Katherine Karaus - Invisible influence: the documentation behind UX copy
Falon Darville - Almost None to Some: Driving DISQO's Doc Culture as a Solo Documentarian
Views 2988 months ago
Falon Darville - Almost None to Some: Driving DISQO's Doc Culture as a Solo Documentarian
Kelly O'Brien - Surprise! You're a designer now.
Views 4.8K2 years ago
Kelly O'Brien - Surprise! You're a designer now.
Document What Matters: Lean Best Practice for Process Documentation - Gillian von Runte
Views 4K3 years ago
Document What Matters: Lean Best Practice for Process Documentation - Gillian von Runte
Building Empathy-Driven Developer Documentation - Kat King - Write the Docs Portland 2018
Views 2.9K3 years ago
Building Empathy-Driven Developer Documentation - Kat King - Write the Docs Portland 2018
Write the Docs Prague 2017: What nobody tells you about documentation by Daniele Procida
Views 2.8K4 years ago
Write the Docs Prague 2017: What nobody tells you about documentation by Daniele Procida
Learning to love release notes - Anne Edwards
Views 2.4K3 years ago
Learning to love release notes - Anne Edwards
Product Documentation Strategy - Kay Miles
Views 2.1K2 years ago
Product Documentation Strategy - Kay Miles
Don't Say Simply - Jim Fisher
Views 2K3 years ago
Don't Say Simply - Jim Fisher
Ryan Paul - Documentation as an application: enabling interactive content tailored to the user
Views 1.9KYear ago
Ryan Paul - Documentation as an application: enabling interactive content tailored to the user
A brief history of text markup languages - Tony Ibbs
Views 1.8K3 years ago
A brief history of text markup languages - Tony Ibbs
James Scott - How to write the perfect error message
Views 1.6K2 years ago
James Scott - How to write the perfect error message
Write the Docs Portland 2017: Treating Documentation like Code: a Practical Account by Jodie Putrino
Views 1.6K4 years ago
Write the Docs Portland 2017: Treating Documentation like Code: a Practical Account by Jodie Putrino
How to edit other people's content without pissing them off - Ingrid Towey
Views 1.3K2 years ago
How to edit other people's content without pissing them off - Ingrid Towey
Kayla Lee - The Super Effective Writing Process of Grammy-winning Artists
Views 1.2K2 years ago
Kayla Lee - The Super Effective Writing Process of Grammy-winning Artists
Margaret Eker, Jennifer Rondeau - Docs as Code: The Missing Manual
Views 1K5 years ago
Margaret Eker, Jennifer Rondeau - Docs as Code: The Missing Manual
Write the Docs Portland 2017: Even Naming This Talk Is Hard by Ruthie BenDor
Views 1K4 years ago
Write the Docs Portland 2017: Even Naming This Talk Is Hard by Ruthie BenDor
Write the Docs Portland 2017: Building navigation for your doc site: 5 best practices by Tom Johnson
Views 9974 years ago
Write the Docs Portland 2017: Building navigation for your doc site: 5 best practices by Tom Johnson
Jen Lambourne - The UK government meets docs as code
Views 9962 years ago
Jen Lambourne - The UK government meets docs as code
Welcome - Write the Docs Portland 2019
Views 9752 years ago
Welcome - Write the Docs Portland 2019
Write the Docs Portland 2017: Error Messages: Being Humble, Human, and Helpful... by Kate Voss
Views 9644 years ago
Write the Docs Portland 2017: Error Messages: Being Humble, Human, and Helpful... by Kate Voss
Swizec Teller - What I learned writing a lousy tech book
Views 9616 years ago
Swizec Teller - What I learned writing a lousy tech book
Draw the Docs - Alicja Raszkowska
Views 9282 years ago
Draw the Docs - Alicja Raszkowska
Lessons Learned in a Year of Docs-Driven Development - Jessica Parsons
Views 9182 years ago
Lessons Learned in a Year of Docs-Driven Development - Jessica Parsons
Abigail Sutherland - Organizing a Confluence hoard, or, does this page spark joy?
Views 890Year ago
Abigail Sutherland - Organizing a Confluence hoard, or, does this page spark joy?
Daniele Procida - Always complete, never finished
Views 8948 months ago
Daniele Procida - Always complete, never finished
Swapnil Ogale - Putting the “tech” in technical writer
Views 8768 months ago
Swapnil Ogale - Putting the “tech” in technical writer
Making Your Code Examples Shine - Larry Ullman - Write the Docs Portland 2018
Views 8693 years ago
Making Your Code Examples Shine - Larry Ullman - Write the Docs Portland 2018
Introduction to Write the Docs Portland 2020
Views 811Year ago
Introduction to Write the Docs Portland 2020
Write the Docs Virtual Conference Guide (2020 Edition)
Views 808Year ago
Write the Docs Virtual Conference Guide (2020 Edition)
Research Like You're Wrong - Jen Lambourne - Write the Docs Portland 2018
Views 8063 years ago
Research Like You're Wrong - Jen Lambourne - Write the Docs Portland 2018
The art and practice of documentation triage - Neal Kaplan - Write the Docs Portland 2018
Views 7573 years ago
The art and practice of documentation triage - Neal Kaplan - Write the Docs Portland 2018

Comments

  • Betsy Dupuis
    Betsy Dupuis 21 day ago

    Idan Gazit is protecting a man that strangled his girlfriend from consequences to further his own career.

  • Naveen Kumar
    Naveen Kumar Month ago

    Great talk about Software documentation one can watch on TheXvid.

  • Alexandra Shagzhina
    Alexandra Shagzhina 3 months ago

    Templates and materials: goo.gl/9bPTtv

  • Alexandra Shagzhina
    Alexandra Shagzhina 3 months ago

    0:20 Introduction 0:31 4 learning tools 0:58 Humans are visual creatures 1:53 Our brains love video 2:08 Engaging documentation 2:30 Types of videos 3:02 6 stages of production 3:31 Research 3:58 Identify value 5:11 Dive deep 5:57 Prioritise -most ROI 7:05 Consolidate into structure 8:01 Script 8:30 Template structure 10:12 Sections 11:09 Quick review 12:07 Recording process 12:47 Tools 14:42 Audio/Voiceover 16:01 Test accounts 16:39 Visual recording 17:37 Edit 18:46 Highlight screen 19:02 Design elements 19:47 Draft feedback 20:06 Share 20:38 Platforms 22:29 Review 23:15 Reach 23:43 Engagement 24:32 Return 25:10 Trello/Maintenance 25:46 Conclusion

  • Ema Writes
    Ema Writes 3 months ago

    Nice

  • lepidoptera
    lepidoptera 4 months ago

    loved this. Great explanations.

  • allyourcode
    allyourcode 4 months ago

    @4:05 I am not sure he realizes it, but this is the most important statement in this whole presentation. He glides through it really fast, so you might have missed it: care about communicating, and that entails consideration of others. When I see bad documentation, I usually attribute it to "empathy fail". That is, the author did not consider the state of mind of his audience. In particular, the author neglected the fact that the audience does not have some prerequisite knowledge that is needed to understand what the author is saying. For example, authors often use terms without defining them. Authors MUST take special care when they using jargon!!! This is absolute basic technical communication 101.

  • Rabia Banu
    Rabia Banu 5 months ago

    The word on his t shirt speaks measures 😕

  • TheMagnificentZoltar
    TheMagnificentZoltar 5 months ago

    Every software engineer should watch this video.

  • Felipe Tambasco
    Felipe Tambasco 7 months ago

    Amazing !

  • S G
    S G 8 months ago

    Hahahahaha man, we've been doing crosswords puzzle in teams before pandemic, every lunch break. Started off with me bringing last page of a newspaper I was subscribed to and went up to buying several books. We even have someone who created a grid with business specific words haha (we're a tech company). Anyway it brought together Devs, Ops, Legal, HR and even once in a while some PO or anyone passing by.

  • Otto Tillis
    Otto Tillis 8 months ago

    POV: you typed grimm but you saw the show so you type grimm val

  • M L
    M L 9 months ago

    This was a great talk!

  • Sarita R
    Sarita R Year ago

    Awesome content..!

  • Tabah Baridule
    Tabah Baridule Year ago

    This is so inspiring and can I get on with lean?

  • Rachiel Vasquez
    Rachiel Vasquez Year ago

    Thank you for sharing this! I’m tasked to do 6 release notes. This will help me a lot! 🙂

  • Reza Ghafari
    Reza Ghafari Year ago

    stupid angle, bad sound, un-usable video - is this the way you document an event ?!

  • noisyturtle
    noisyturtle 2 years ago

    Good tips here.

  • sonofblessed
    sonofblessed 2 years ago

    This is very deep. I momentarily read it as "Learning to love release - notes."

  • Hinto
    Hinto 2 years ago

    Great little summary!

  • Carlos-Enrique Tafur Egido

    Pandoc's is the best Markdown's flavour.

  • Liam Guy Hiram Proven

    "All fungi are edible. Some fungi are only edible once." - Terry Pratchett.

  • Eric Nambo
    Eric Nambo 2 years ago

    Can this be changed to reflect the actual title of the presentation, Documenting Accessibility? Thanks! - Eric, the presenter

  • Sandiip Kakadde
    Sandiip Kakadde 2 years ago

    Really helpful. Would be sharing it with all...

  • Eileen Kern
    Eileen Kern 3 years ago

    The slides are currently on the speaker's website: www.thursdaybram.com/wp-content/uploads/2016/05/Thursday-Bram-%E2%80%94-Write-the-Docs-2016-1.pdf

  • Marie-Louise Flacke
    Marie-Louise Flacke 3 years ago

    Good point when designing a video (at 15"13) "Speak really clearly and slower than your normal conversation ...Too fast it'll be hard to keep up and too slow, people will disengage"...IMHO, this should also apply when making a presentation in English in a non-English speaking country (let's say where English is not the first language). ;-)

  • Bianca Wilk
    Bianca Wilk 3 years ago

    Very interesting talk. Thank you, Marcelina!

  • RodJammCam
    RodJammCam 3 years ago

    How young were you when you started?I started pretty young.I also designed a new online crossword where you get a treasure, that I wouldn't mind puzzlers giving me some feedback on.Perhaps it could create a new wave of fever for crosswords. www.rodjmscrosssuperpuzzle.com

  • promillenium
    promillenium 3 years ago

    Lyrics: (Gospel style spoken word) Have you ever been in a situation Using open source software, And you can’t work out how to run it? Wouldn’t it feel real good to make a difference? To make it right? (Verse) As I open the manual To do my task at hand, I find it’s so hard to read. It’s a mess, duplicates, Ambiguities! Who am I, to be blind, pretending that I can’t proofread? (Pre-chorus) A website 404, Then tweeting back and forth, How to make that change? My comments got lost in the backlog black hole 'Till I found the place to go, And I found I wasn’t alone… (Chorus) I’m starting with a fork of the repo. I’m asking you to change the text. The message gonna get so much clearer. If you wanna make the docs a better place, Checkout a branch, make a pull request. Chorus x2 ------------------ Make a pull request! github.com/vstirbu/writethelirycs

  • Predrag Mandic
    Predrag Mandic 3 years ago

    Rundoc is open-source (BSD license): gitlab.com/nul.one/rundoc github.com/EclecticIQ/rundoc

  • Marie-Louise Flacke
    Marie-Louise Flacke 3 years ago

    What's the objective here? listening to an (old fashion) "ex cathedra" course????

  • Alec Clews
    Alec Clews 3 years ago

    Canny is a word

  • C R
    C R 3 years ago

    Beautiful, thank you for sharing.

  • Tim Swast
    Tim Swast 3 years ago

    Excellent framework for docs (tutorial, topics, how-to, reference) and well-articulated. Great to hear that documentation is considered a core part of the Django project.

  • Kayce Basques
    Kayce Basques 3 years ago

    That's me! Like I said, my goal is to build a little community of like-minded folks who want to figure out metrics together. Message me if you want to join! Link to slides: docs.google.com/presentation/d/1xh6UbX7yJGrxRblywBXekLLGylzSygMJZg0lZuHy9Tc

  • Jillian Woods
    Jillian Woods 3 years ago

    What book is she referencing at 4:40?

  • Gregor Martynus
    Gregor Martynus 4 years ago

    Bummer that slides / demo is not shown. Great talk otherwise!

    • Bill Brown
      Bill Brown 3 years ago

      speakerdeck.com/gjtorikian/finally-trustworthy-and-sensible-api-documentation-with-graphql

  • Dee Vincent-Day MISTC

    No slides for Chris Ward's presentation? :(

  • Debby Andell
    Debby Andell 4 years ago

    very informative!

  • jyveturkie
    jyveturkie 5 years ago

    Are there any good checklist creation tools online you can recommend?

  • John Whitlock
    John Whitlock 5 years ago

    Are the slides available?

  • Marc Palumbo
    Marc Palumbo 5 years ago

    Getting to know you.

  • István Zoltán Szabó

    You can find my slides here: docs.google.com/presentation/d/1wbzJUM6EGWrjiew36uZcYkmqLW34oH_8KolyCtkuocI/edit?usp=sharing And here is the blog post version of my presentation: pronovix.com/blog/writing-non-native-speaker

  • Margaret Eker
    Margaret Eker 5 years ago

    Slideshare for this talk is available at bit.ly/2d457vR

  • Derek E. Baird
    Derek E. Baird 5 years ago

    Really informative information. Thanks for sharing, Riona.

  • Etienne N
    Etienne N 5 years ago

    Found the slides here: speakerdeck.com/idangazit/web-typography-state-of-the-art

  • Eva evey
    Eva evey 6 years ago

    damn he's hot and smart <3