Write The Docs Podcast & Meetups
Write The Docs Podcast & Meetups
  • Video 60
  • Views 15 669
WTD East Coast August '21: Good vs. Bad API Documentation
API documentation is almost always the defining reason an individual or organization decides to integrate with a 3rd-party service. Therefore, publishing good documentation is of paramount importance.

API documentation at its best is informational, educational, technical, and promotional. It's an opportunity to identify with users and prospects, and their use-cases.

Symptoms of bad (or not so good) API documentation are: low adoption, sporadic interaction, high error rates, etc., which may be the result of any one (or more) of a variety of causes such as inaccessibility, inconsistencies (in documentation), low informational content, low educational content, high jargon, and more.

Al Newkirk ...
Views: 53

Video

Write the Docs Tel Aviv Meetup - Python for Documentarians
Views 562 months ago
Write the Docs Tel Aviv Meetup - Python for Documentarians
WTD Podcast Episode 35: Docs for Developers, with Jared Bhatti and Zachary Sarah Corleissen
Views 2222 months ago
In this podcast, we discuss the newly released book Docs for Developers: An Engineer's Field Guide to Technical Writing with Jared Bhatti, staff technical writer at Google, and Zachary Sarah Corleissen, staff technical writer at Stripe. This book on writing documentation focuses on the end-to-end writing process (from audience analysis to drafting, editing, publishing, and more) and is written ...
API Documentation Workshop for Beginners
Views 1734 months ago
API documentation is a technical content deliverable, containing instructions about how to effectively use and integrate with an API
How To Churn Out Technical Content
Views 1125 months ago
This video gives a clear explanation of how one can churn out technical content and be consistent with it.
WTD West Coast June '21: Behind-the-scenes from idea to API at Redocly
Views 475 months ago
Look behind the curtains to see how Redocly ties documentation to innovation when bringing an API idea to life. Speaker: Adam Altman, CEO & Founder at Redocly Recorded during the June 2021 session of Write the Docs West Coast Quorum. Hosted by WTD Bay Area’s Debra Eskinazi. West Coast Quorum group on Meetup: www.meetup.com/virtual-write-the-docs-west-coast-quorum/ Check out all of our Meetup gr...
Open source tools for API Documentation - WtD EMEA Meetup (June 24 2021)
Views 3296 months ago
A hands-on review of the most recent open source API documentation toolchains, such as ReDoc, Widdershins, and the newest solutions from Stoplight and Adyen, among others. Slides: docs.google.com/presentation/d/1YiKsNi609GG5N_czDGE9uUU2gy8j_ryou91T4u0z3CA/edit?usp=sharing
WTD Podcast episode 34: Adding personality to Documentation with Fabrizio Ferri
Views 2547 months ago
Are tech writers averse to publicity or does our industry not allow for it? And if you want to be a "personality" in the tech communications world what do you do? How do you add personality constructively to your work? Tom Johnson and Chris Ward speak with Fabrizio Ferri to discuss
WTD East Coast May '21: The Future of Illusions
Views 487 months ago
At most companies, marketing and technical communications rarely unite even though both professions create content. Also, rumors abound that new technologies, such as chatbots and artificial intelligence (AI) might reduce the necessity of both roles or increase internal struggles for their funding. Learn how content created by Salesforce is displacing the future of these illusions. In this talk...
Opportunities in Technical writing and Documentation.
Views 959 months ago
It is a talk about the opportunities in the technical writing and documentation space.
WTD Vilnius - How to build strong techwriters community - lessons from Poland
Views 1479 months ago
Dariusz Drezno, co-founder of Techwriter.pl and ITCQF.org will share the story of Polish techwriters community. If you want to learn how to make techcomm more visible in your country and what options techwriters have to grow and share their knowledge - this presentation is for you. Spoiler - no budget required to follow recipe from Poland!
WTD Ireland 08 Apr 21 "Relationships matter -- UX writing: the bridge between users and engineers"
Views 979 months ago
For our April meetup, Priscill Orue, Jennifer Ciroli, and Ingrid Towey talked about why relationships are key when it comes to UX writing and how to focus on the bridge between users and engineers.
Building a documentation site with Markdown and Jekyll
Views 2959 months ago
we shall discuss Jekyll as a tool and Markdown which is a markup language. to be proficient as a documentarian, tools like this are essential for your job responsibility.
WTD West Coast, March '21: "The Product is Docs: A Look Inside"
Views 1779 months ago
Listen to a panel of Splunk documentarians as they present four lightning talks based on their book, The Product is Docs. The presenters each take a few minutes to highlight key points from the chapters on Working with User Experience and Design, Customer Feedback and Community, and Technical Editing. The final lightning talk describes the XP-inspired writing process for the chapter on Writing ...
WTD EMEA March - Git Basics Workshop with Anna Skoulikari
Views 22910 months ago
Many of us in our technical writing (or other) work will need to use Git version control. But Git can be a bit scary and confusing to work with! In this workshop Anna Skoulikari is going to go over some Git basics such as: - What is the difference between Git and GitHub? - What is a commit really? - How does the staging area work? - What exactly are branches? She will introduce the above in a w...
WTD East Coast, Feb '21: "Lessoned learned open-sourcing GitHub Docs" with Kathy Korevec
Views 7610 months ago
WTD East Coast, Feb '21: "Lessoned learned open-sourcing GitHub Docs" with Kathy Korevec
WTD India Feb 2021 - "Connection with CX and DX from Content Developer Lens" by Ruchi Vohra.
Views 2510 months ago
WTD India Feb 2021 - "Connection with CX and DX from Content Developer Lens" by Ruchi Vohra.
WTD India Feb 2021 - "Breaking the glass ceiling for Tech Writers" by Mridula Menon.
Views 3410 months ago
WTD India Feb 2021 - "Breaking the glass ceiling for Tech Writers" by Mridula Menon.
WTD India Feb 2021 - "Mathematical Models for Technical Storytelling" by Prasanjit Singh.
Views 5010 months ago
WTD India Feb 2021 - "Mathematical Models for Technical Storytelling" by Prasanjit Singh.
WTD India Feb 2021 - "Accessible documentation" by Manasi Gandhi.
Views 2410 months ago
WTD India Feb 2021 - "Accessible documentation" by Manasi Gandhi.
WTD India Feb 2021 - Welcome!
Views 4610 months ago
WTD India Feb 2021 - Welcome!
Emotional personas: writing for the human animal
Views 10810 months ago
Emotional personas: writing for the human animal
WTD EMEA - What skills and competencies do documentarians need
Views 16411 months ago
WTD EMEA - What skills and competencies do documentarians need
Write The Docs Proposal Meetup 2021, Part 1
Views 20211 months ago
Write The Docs Proposal Meetup 2021, Part 1
Write The Docs 2021 Proposal Prep Meetup, Part 2
Views 911 months ago
Write The Docs 2021 Proposal Prep Meetup, Part 2
Write the Docs podcast episode 33: Simplified user interfaces
Views 372Year ago
Write the Docs podcast episode 33: Simplified user interfaces
5 Tips for Accessible Docs
Views 481Year ago
5 Tips for Accessible Docs
Prepare for the Unexpected: A Story about Knowledge Management
Views 80Year ago
Prepare for the Unexpected: A Story about Knowledge Management
The Rocky Road to Docs as Code: Opportunities and Pitfalls in Migrating to Docs as Code
Views 203Year ago
The Rocky Road to Docs as Code: Opportunities and Pitfalls in Migrating to Docs as Code
WTD Episode 32: Self-publishing, with Mehmed Pasic
Views 107Year ago
WTD Episode 32: Self-publishing, with Mehmed Pasic
WTD Episode 19: Static site generators
Views 8092 years ago
WTD Episode 19: Static site generators
WTD Episode 17: Structured Writing with Mark Baker
Views 6553 years ago
WTD Episode 17: Structured Writing with Mark Baker
WTD Episode 13: Postman for API development and docs
Views 5933 years ago
WTD Episode 13: Postman for API development and docs
WTD Episode 9: Chatbots in Documentation
Views 5734 years ago
WTD Episode 9: Chatbots in Documentation
WTD Episode 5: Where Do We Belong?
Views 5194 years ago
WTD Episode 5: Where Do We Belong?
WTD Episode 4: Continuous Integration and Docs as Code
Views 5044 years ago
WTD Episode 4: Continuous Integration and Docs as Code
WTD Episode 3: Trends for 2017 and Beyond
Views 5024 years ago
WTD Episode 3: Trends for 2017 and Beyond
WTD Episode 20: Minimum requirements for good tech docs, with Matt Reiner
Views 4962 years ago
WTD Episode 20: Minimum requirements for good tech docs, with Matt Reiner
5 Tips for Accessible Docs
Views 481Year ago
5 Tips for Accessible Docs
WTD Episode 14: Humanising your documentation
Views 4633 years ago
WTD Episode 14: Humanising your documentation
WTD Episode 1: Kicking off WTD Podcast
Views 4365 years ago
WTD Episode 1: Kicking off WTD Podcast
Berlin Meetup 9th March 2020 - UX Writing
Views 421Year ago
Berlin Meetup 9th March 2020 - UX Writing
WTD Episode 16: An open-source Grammarly for tech docs?
Views 4113 years ago
WTD Episode 16: An open-source Grammarly for tech docs?
Write the Docs podcast episode 33: Simplified user interfaces
Views 372Year ago
Write the Docs podcast episode 33: Simplified user interfaces
Writing with empathy: how to make software human and relatable
Views 355Year ago
Writing with empathy: how to make software human and relatable
Open source tools for API Documentation - WtD EMEA Meetup (June 24 2021)
Views 3296 months ago
A hands-on review of the most recent open source API documentation toolchains, such as ReDoc, Widdershins, and the newest solutions from Stoplight and Adyen, among others. Slides: docs.google.com/presentation/d/1YiKsNi609GG5N_czDGE9uUU2gy8j_ryou91T4u0z3CA/edit?usp=sharing
WTD Podcast Episode 30: Templates with Juan Lara
Views 320Year ago
WTD Podcast Episode 30: Templates with Juan Lara
WTD Episode 2: Findability in Documentation
Views 3155 years ago
WTD Episode 2: Findability in Documentation
WTD Episode 21: On career growth, leadership, and mentoring in Tech Writing
Views 3122 years ago
WTD Episode 21: On career growth, leadership, and mentoring in Tech Writing
Building a documentation site with Markdown and Jekyll
Views 2959 months ago
we shall discuss Jekyll as a tool and Markdown which is a markup language. to be proficient as a documentarian, tools like this are essential for your job responsibility.
WTD Episode 25: Researching how developers use API docs
Views 2842 years ago
WTD Episode 25: Researching how developers use API docs
WTD Episode 7: Let The Robots Do The Work
Views 2714 years ago
WTD Episode 7: Let The Robots Do The Work
WTD Episode 22: Managing Multiple Docs Projects Across Git Repositories
Views 2602 years ago
WTD Episode 22: Managing Multiple Docs Projects Across Git Repositories
WTD Podcast Episode 27: Starting a doc group/process when you're the first
Views 257Year ago
WTD Podcast Episode 27: Starting a doc group/process when you're the first
WTD Podcast episode 34: Adding personality to Documentation with Fabrizio Ferri
Views 2547 months ago
Are tech writers averse to publicity or does our industry not allow for it? And if you want to be a "personality" in the tech communications world what do you do? How do you add personality constructively to your work? Tom Johnson and Chris Ward speak with Fabrizio Ferri to discuss
WTD EMEA March - Git Basics Workshop with Anna Skoulikari
Views 22910 months ago
Many of us in our technical writing (or other) work will need to use Git version control. But Git can be a bit scary and confusing to work with! In this workshop Anna Skoulikari is going to go over some Git basics such as: - What is the difference between Git and GitHub? - What is a commit really? - How does the staging area work? - What exactly are branches? She will introduce the above in a w...
WTD Episode 26: Tech Writing and Reddit
Views 2272 years ago
WTD Episode 26: Tech Writing and Reddit
WTD Episode 6: Metadata and UI Copy
Views 2224 years ago
WTD Episode 6: Metadata and UI Copy
WTD Podcast Episode 35: Docs for Developers, with Jared Bhatti and Zachary Sarah Corleissen
Views 2222 months ago
In this podcast, we discuss the newly released book Docs for Developers: An Engineer's Field Guide to Technical Writing with Jared Bhatti, staff technical writer at Google, and Zachary Sarah Corleissen, staff technical writer at Stripe. This book on writing documentation focuses on the end-to-end writing process (from audience analysis to drafting, editing, publishing, and more) and is written ...
The Rocky Road to Docs as Code: Opportunities and Pitfalls in Migrating to Docs as Code
Views 203Year ago
The Rocky Road to Docs as Code: Opportunities and Pitfalls in Migrating to Docs as Code

Comments

  • Tabah Baridule
    Tabah Baridule 4 months ago

    Thank you for sharing this

  • G
    G 6 months ago

    Chris Ward is soo good... didn't catch the name of his site... can someone pls provide the url... thank you.

  • Jerry Kakooza
    Jerry Kakooza 9 months ago

    Someone please share with me the link to join the whatsapp group

  • 3x3basket.pl
    3x3basket.pl 9 months ago

    So happy to be mentioned here! High five to all Lithuanian 3x3 baskeball players :)

  • Jerry Kakooza
    Jerry Kakooza 10 months ago

    Wow this is so awesome

  • Brett
    Brett 11 months ago

    Really loved this one. Super informative.

  • Mark Waterman
    Mark Waterman Year ago

    Phase 1: Provide templates to help developers write docs. Phase 2: Introduce linting tools to help enforce the headings and structure of markdown files based on information type. Phase 3: Introduce twelve mandatory frontmatter fields for the linter's... um... oh crap, we just re-invented DITA for markdown. Seriously, though, this was good discussion.

  • Luna Jernberg
    Luna Jernberg Year ago

    Having some time today, so watching the sessions now

  • farmerofbits
    farmerofbits Year ago

    North Cascades FTW!

  • Ryan Schmid
    Ryan Schmid 2 years ago

    Well done guys. I enjoyed the conversation, especially around anonymity and the internet.

  • carnotricecooker
    carnotricecooker 2 years ago

    24:35 for TLDR on SSG's

  • Mel
    Mel 2 years ago

    Andrew looked so happy and enthusiastic the entire time

  • tubeMonger
    tubeMonger 2 years ago

    As a Finnish person who aspires of becoming a technical communicator, this video is very helpful. Hungarian and Finnish are similar in many ways. I've been writing step-by-step instructions as well as blog posts for a software company. These writings try to communicate the software product to two different audiences, those of technically savvy people and marketers (in layman's terms).

  • Joshua Gillespie
    Joshua Gillespie 2 years ago

    Hi, I'm new to documentation as a topic. As part of a course I'm doing at TAFE, do you have any information for people who are new to this. I found this video informative over exposure what your talking about.

  • A I
    A I 2 years ago

    I’m happy I found this. Thank you guys.

  • Shaloo Shalini
    Shaloo Shalini 4 years ago

    * Proactive approach to getting included into Engg activities is smart move. 👍 * Trend: Bringing together Marketing / MarComm / Tech Communication will surely help the documentation supply chain and benefit the customer.[Facts->What user needs to know-> Marketing for new leads] * Git as a documentation tool. Docs are new addition to code esp for APIs and toolkits.

  • Swapnil Ogale
    Swapnil Ogale 5 years ago

    Some really good "content" here on this podcast. Good work Chris, Tom, Jared and Carlee.