Before the docs: writing for user interfaces

Beth Aitman
Technical writer at Improbable
Sep. 2, 2015••
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
Before the docs: writing for user interfaces
1 of 85

Before the docs: writing for user interfaces

Sep. 2, 2015••
Download to read offline
Design
Technology

Given at Write the Docs Europe, 2015. See the write-up here (https://docs.google.com/document/d/1HTuKl4gSOcqdqYY72MK_frbTpHb73j_WnZN3HExp184/edit?usp=sharing) Good documentation is important, but it should be your last resort. You need to help users before they reach the docs - in the user interface itself. In this talk, I discuss: - strategies for writing microcopy when you’re short on space - what to explain in the UI, and what to save for the documentation - how to pick the right style of embedded help - what makes a great error message (and a terrible one) ... with plenty of real-world examples of doing it right and wrong. If you're interested in this, see my blog for more detailed examples: http://uiwriting.tumblr.com/

Beth Aitman
Technical writer at Improbable

Recommended

10 najlepszych praktyk projektowania elearningu10 najlepszych praktyk projektowania elearningu
10 najlepszych praktyk projektowania elearninguPiotr Peszko1.7K views•31 slides
Error Message ImprovementError Message Improvement
Error Message Improvementmschwirzke821 views•19 slides
Writing Effective Messages - Michelle CareyWriting Effective Messages - Michelle Carey
Writing Effective Messages - Michelle CareyInformation Development World3.1K views•50 slides
Error Messages In Software ApplicationsError Messages In Software Applications
Error Messages In Software ApplicationsRaghunath (Gautam) Soman2.7K views•22 slides
Gardening open docs - Write the Docs - Prague 2015Gardening open docs - Write the Docs - Prague 2015
Gardening open docs - Write the Docs - Prague 2015teoli20031.3K views•20 slides
Socjologia internetu – pesymistyczne poglądy na temat internetuSocjologia internetu – pesymistyczne poglądy na temat internetu
Socjologia internetu – pesymistyczne poglądy na temat internetuPiotr Siuda1.8K views•38 slides

More Related Content

More from Beth Aitman

Who Writes the Docs?Who Writes the Docs?
Who Writes the Docs?Beth Aitman244 views•31 slides
Models for personal growth: career progression for tech writersModels for personal growth: career progression for tech writers
Models for personal growth: career progression for tech writersBeth Aitman869 views•20 slides
Finding the right work to do: Lessons learnt from a year at a startupFinding the right work to do: Lessons learnt from a year at a startup
Finding the right work to do: Lessons learnt from a year at a startupBeth Aitman254 views•35 slides
Writing for better user interfaces (Home Office)Writing for better user interfaces (Home Office)
Writing for better user interfaces (Home Office)Beth Aitman175 views•78 slides
Writing for better user interfaces (GDS)Writing for better user interfaces (GDS)
Writing for better user interfaces (GDS)Beth Aitman657 views•78 slides
Software that makes sense: writing for user interfacesSoftware that makes sense: writing for user interfaces
Software that makes sense: writing for user interfacesBeth Aitman601 views•84 slides

More from Beth Aitman(6)

Who Writes the Docs?Who Writes the Docs?
Who Writes the Docs?
Beth Aitman•244 views
Models for personal growth: career progression for tech writersModels for personal growth: career progression for tech writers
Models for personal growth: career progression for tech writers
Beth Aitman•869 views
Finding the right work to do: Lessons learnt from a year at a startupFinding the right work to do: Lessons learnt from a year at a startup
Finding the right work to do: Lessons learnt from a year at a startup
Beth Aitman•254 views
Writing for better user interfaces (Home Office)Writing for better user interfaces (Home Office)
Writing for better user interfaces (Home Office)
Beth Aitman•175 views
Writing for better user interfaces (GDS)Writing for better user interfaces (GDS)
Writing for better user interfaces (GDS)
Beth Aitman•657 views
Software that makes sense: writing for user interfacesSoftware that makes sense: writing for user interfaces
Software that makes sense: writing for user interfaces
Beth Aitman•601 views

Recently uploaded

Plan Your Perfect Princess Theme Birthday Party with The Fairy Godmother Even...Plan Your Perfect Princess Theme Birthday Party with The Fairy Godmother Even...
Plan Your Perfect Princess Theme Birthday Party with The Fairy Godmother Even...TheFairyGodmotherEve8 views•12 slides
Amazon A Plus Content Visually Appealing.pptxAmazon A Plus Content Visually Appealing.pptx
Amazon A Plus Content Visually Appealing.pptxSherylEleazar359 views•7 slides
Catalogue rapido 2023_compressed.pdfCatalogue rapido 2023_compressed.pdf
Catalogue rapido 2023_compressed.pdfJoe Nguyen18 views•25 slides
Urban Planning Lecture 3.pptxUrban Planning Lecture 3.pptx
Urban Planning Lecture 3.pptxIftikhar Ahmad Mukhtar8 views•31 slides
02.ChatGPT - Practice Set Assignment - Day 02.pptx02.ChatGPT - Practice Set Assignment - Day 02.pptx
02.ChatGPT - Practice Set Assignment - Day 02.pptxsudheerkumarchokkara8 views•14 slides
Proof That UI UX Really WorksProof That UI UX Really Works
Proof That UI UX Really WorksSamer Tallauze9 views•39 slides

Recently uploaded(17)

Plan Your Perfect Princess Theme Birthday Party with The Fairy Godmother Even...Plan Your Perfect Princess Theme Birthday Party with The Fairy Godmother Even...
Plan Your Perfect Princess Theme Birthday Party with The Fairy Godmother Even...
TheFairyGodmotherEve•8 views
Amazon A Plus Content Visually Appealing.pptxAmazon A Plus Content Visually Appealing.pptx
Amazon A Plus Content Visually Appealing.pptx
SherylEleazar•359 views
Catalogue rapido 2023_compressed.pdfCatalogue rapido 2023_compressed.pdf
Catalogue rapido 2023_compressed.pdf
Joe Nguyen•18 views
Urban Planning Lecture 3.pptxUrban Planning Lecture 3.pptx
Urban Planning Lecture 3.pptx
Iftikhar Ahmad Mukhtar•8 views
02.ChatGPT - Practice Set Assignment - Day 02.pptx02.ChatGPT - Practice Set Assignment - Day 02.pptx
02.ChatGPT - Practice Set Assignment - Day 02.pptx
sudheerkumarchokkara•8 views
Proof That UI UX Really WorksProof That UI UX Really Works
Proof That UI UX Really Works
Samer Tallauze•9 views
661C 6.pdf661C 6.pdf
661C 6.pdf
Nicholas Gioia•5 views
Are designers ready for a product-first process?Are designers ready for a product-first process?
Are designers ready for a product-first process?
Remy Rey De Barros•13 views
Maximizing ROI with Odoo ERP: Measuring PerformanceMaximizing ROI with Odoo ERP: Measuring Performance
Maximizing ROI with Odoo ERP: Measuring Performance
CandidRoot Solutions Private Limited •5 views
Architectural PortfolioArchitectural Portfolio
Architectural Portfolio
VivekKhuthiya•16 views
Logo Designer San DiegoLogo Designer San Diego
Logo Designer San Diego
JenniferAIS•6 views
Cushion chair | AMECushion chair | AME
Cushion chair | AME
Dinesh397947•8 views
MGM Research.pptxMGM Research.pptx
MGM Research.pptx
ssuser88cf801•19 views
Enceladus vehicle - Nasa challenge Super heavy logistics transport.pdfEnceladus vehicle - Nasa challenge Super heavy logistics transport.pdf
Enceladus vehicle - Nasa challenge Super heavy logistics transport.pdf
AndresIborra2•10 views
How might we improve the efficiency of bank transfer process on the UOB TMRW ...How might we improve the efficiency of bank transfer process on the UOB TMRW ...
How might we improve the efficiency of bank transfer process on the UOB TMRW ...
Faizal Masjudi•40 views
Martha Schwartz.pptxMartha Schwartz.pptx
Martha Schwartz.pptx
Ajman University•10 views
Transformational EngagementTransformational Engagement
Transformational Engagement
Jesse Schell•16 views

Before the docs: writing for user interfaces