SlideShare una empresa de Scribd logo
1 de 23
Descargar para leer sin conexión
Confessions of a
technical writer
9.
Nobody notices
   what I do

 Until I fail
  to do it
8.
A game of scrabble
takes 4 days,
7 dictionaries,
and a duel to
the death.
7.
 I hate help desk


(But they love me)
6.
I don’t read manuals
Users
Contributors
Developers
5.
   Working wit
developers     h
           i s h ar d
4.
       waterf a l l s
I like
Information
   Plan
   (10%)
                   Content
                Specification
                    (20%)
                                                   Release

                                   Writing
                                    (50%)
                                          Translation       Review
                                                &            (1%)




                                                        `
                                                        `
                                           Production
                                              (19%)

   5 Phase Model by JoAnn Hackos
3.
Sometimes,
 things go
  BANG!
2. cial
      p e
    s         t
I’m          o l
            n a
         ’ m ci
        I e
    ut sp
  B T
    H A
  T
Get
      organised
Choose
 your
 voice
Say what you mean
Use short sentences
Try not to be...




                   A pretentious jerk
A word about




               passive voice
                  (and cats)
Cut out the cruft
Read what you write
1.
I will not stab you

      Today.
My name is   lanabrindley@gmail.com
Lana
Brindley.

              @Loquacities
And I am a
technical
writer.       0410 500 659

Más contenido relacionado

Destacado

MAGIC of the twitisphere.... Making the writing programme fun
MAGIC of the twitisphere.... Making the writing programme funMAGIC of the twitisphere.... Making the writing programme fun
MAGIC of the twitisphere.... Making the writing programme funCraig Hansen
 
No Boring Content Allowed!
No Boring Content Allowed!No Boring Content Allowed!
No Boring Content Allowed!Steph Hay
 
What every teacher should know about cognitive science
What every teacher should know about cognitive scienceWhat every teacher should know about cognitive science
What every teacher should know about cognitive scienceStephanie Chasteen
 
Writing Code to Work Against any Salesforce Object
Writing Code to Work Against any Salesforce ObjectWriting Code to Work Against any Salesforce Object
Writing Code to Work Against any Salesforce ObjectSalesforce Developers
 
GetBadges - gamification platform for software developers
GetBadges - gamification platform for software developersGetBadges - gamification platform for software developers
GetBadges - gamification platform for software developersJustyna Wojtczak
 
Village workshop - Tech Ideas to Make Writing Fun
Village workshop - Tech Ideas to Make Writing FunVillage workshop - Tech Ideas to Make Writing Fun
Village workshop - Tech Ideas to Make Writing Funcmacconnell
 
ADVERGAME, quand la marque se met au jeu
ADVERGAME, quand la marque se met au jeuADVERGAME, quand la marque se met au jeu
ADVERGAME, quand la marque se met au jeuVincent PUREN
 
How Cognitive Science Can Help You Through School
How Cognitive Science Can Help You Through SchoolHow Cognitive Science Can Help You Through School
How Cognitive Science Can Help You Through SchoolJim Davies
 
Gamification: Make Freelance Writing More Fun
Gamification: Make Freelance Writing More FunGamification: Make Freelance Writing More Fun
Gamification: Make Freelance Writing More FunJennifer Mattern
 
Monika Konieczny - Gamification & storytelling: how to turn boring technical ...
Monika Konieczny - Gamification & storytelling: how to turn boring technical ...Monika Konieczny - Gamification & storytelling: how to turn boring technical ...
Monika Konieczny - Gamification & storytelling: how to turn boring technical ...soapconf
 
Communication with Flexible Documentation : Jon Hadden
Communication with Flexible Documentation : Jon HaddenCommunication with Flexible Documentation : Jon Hadden
Communication with Flexible Documentation : Jon HaddenNomensa
 
Present day english
Present day englishPresent day english
Present day englishdagdag
 
This is Your Brain on Content: Cognitive Science Lessons for Content Strategy
This is Your Brain on Content: Cognitive Science Lessons for Content StrategyThis is Your Brain on Content: Cognitive Science Lessons for Content Strategy
This is Your Brain on Content: Cognitive Science Lessons for Content StrategyNoz Urbina
 
Fun at work through innovation games
Fun at work through innovation gamesFun at work through innovation games
Fun at work through innovation gamesSrinath Ramakrishnan
 
12 Secrets of Making Every Presentation Fun, Engaging and Enjoyable
12 Secrets of Making Every Presentation Fun, Engaging and Enjoyable12 Secrets of Making Every Presentation Fun, Engaging and Enjoyable
12 Secrets of Making Every Presentation Fun, Engaging and EnjoyableSketchBubble
 
Qualities of good technical writing with examples
Qualities of good technical writing with examplesQualities of good technical writing with examples
Qualities of good technical writing with examplesmuhammad ilyas
 

Destacado (19)

MAGIC of the twitisphere.... Making the writing programme fun
MAGIC of the twitisphere.... Making the writing programme funMAGIC of the twitisphere.... Making the writing programme fun
MAGIC of the twitisphere.... Making the writing programme fun
 
No Boring Content Allowed!
No Boring Content Allowed!No Boring Content Allowed!
No Boring Content Allowed!
 
What every teacher should know about cognitive science
What every teacher should know about cognitive scienceWhat every teacher should know about cognitive science
What every teacher should know about cognitive science
 
Writing Code to Work Against any Salesforce Object
Writing Code to Work Against any Salesforce ObjectWriting Code to Work Against any Salesforce Object
Writing Code to Work Against any Salesforce Object
 
Judges training m wright food and nutrition 2013
Judges training m wright food and nutrition 2013Judges training m wright food and nutrition 2013
Judges training m wright food and nutrition 2013
 
Portfolio2
Portfolio2Portfolio2
Portfolio2
 
GetBadges - gamification platform for software developers
GetBadges - gamification platform for software developersGetBadges - gamification platform for software developers
GetBadges - gamification platform for software developers
 
Village workshop - Tech Ideas to Make Writing Fun
Village workshop - Tech Ideas to Make Writing FunVillage workshop - Tech Ideas to Make Writing Fun
Village workshop - Tech Ideas to Make Writing Fun
 
ADVERGAME, quand la marque se met au jeu
ADVERGAME, quand la marque se met au jeuADVERGAME, quand la marque se met au jeu
ADVERGAME, quand la marque se met au jeu
 
How Cognitive Science Can Help You Through School
How Cognitive Science Can Help You Through SchoolHow Cognitive Science Can Help You Through School
How Cognitive Science Can Help You Through School
 
Gamification: Make Freelance Writing More Fun
Gamification: Make Freelance Writing More FunGamification: Make Freelance Writing More Fun
Gamification: Make Freelance Writing More Fun
 
Monika Konieczny - Gamification & storytelling: how to turn boring technical ...
Monika Konieczny - Gamification & storytelling: how to turn boring technical ...Monika Konieczny - Gamification & storytelling: how to turn boring technical ...
Monika Konieczny - Gamification & storytelling: how to turn boring technical ...
 
Communication with Flexible Documentation : Jon Hadden
Communication with Flexible Documentation : Jon HaddenCommunication with Flexible Documentation : Jon Hadden
Communication with Flexible Documentation : Jon Hadden
 
Present day english
Present day englishPresent day english
Present day english
 
This is Your Brain on Content: Cognitive Science Lessons for Content Strategy
This is Your Brain on Content: Cognitive Science Lessons for Content StrategyThis is Your Brain on Content: Cognitive Science Lessons for Content Strategy
This is Your Brain on Content: Cognitive Science Lessons for Content Strategy
 
Fun at work through innovation games
Fun at work through innovation gamesFun at work through innovation games
Fun at work through innovation games
 
12 Secrets of Making Every Presentation Fun, Engaging and Enjoyable
12 Secrets of Making Every Presentation Fun, Engaging and Enjoyable12 Secrets of Making Every Presentation Fun, Engaging and Enjoyable
12 Secrets of Making Every Presentation Fun, Engaging and Enjoyable
 
Qualities of good technical writing with examples
Qualities of good technical writing with examplesQualities of good technical writing with examples
Qualities of good technical writing with examples
 
Technical Writing
Technical WritingTechnical Writing
Technical Writing
 

Más de Lana Brindley

Open Source Docs: The Good, The Bad, and the WTF?!
Open Source Docs: The Good, The Bad, and the WTF?!Open Source Docs: The Good, The Bad, and the WTF?!
Open Source Docs: The Good, The Bad, and the WTF?!Lana Brindley
 
Open Source Documentation in Four Easy Steps (and one slightly more difficult...
Open Source Documentation in Four Easy Steps (and one slightly more difficult...Open Source Documentation in Four Easy Steps (and one slightly more difficult...
Open Source Documentation in Four Easy Steps (and one slightly more difficult...Lana Brindley
 
The Grass is Greener on the Open Side
The Grass is Greener on the Open SideThe Grass is Greener on the Open Side
The Grass is Greener on the Open SideLana Brindley
 
Technical Writing for Hoopy Open Source Froods Who Really Know Where Their To...
Technical Writing for Hoopy Open Source Froods Who Really Know Where Their To...Technical Writing for Hoopy Open Source Froods Who Really Know Where Their To...
Technical Writing for Hoopy Open Source Froods Who Really Know Where Their To...Lana Brindley
 
Think It. Make It. Change the World.
Think It. Make It. Change the World.Think It. Make It. Change the World.
Think It. Make It. Change the World.Lana Brindley
 
Getting Women into Open Source - The Easy Way
Getting Women into Open Source - The Easy WayGetting Women into Open Source - The Easy Way
Getting Women into Open Source - The Easy WayLana Brindley
 
Writing Beautiful Technical Documentation
Writing Beautiful Technical DocumentationWriting Beautiful Technical Documentation
Writing Beautiful Technical DocumentationLana Brindley
 
Getting started With Linux: how NOT to do it.
Getting started With Linux: how NOT to do it.Getting started With Linux: how NOT to do it.
Getting started With Linux: how NOT to do it.Lana Brindley
 
Technical writing: A fairy tale
Technical writing: A fairy taleTechnical writing: A fairy tale
Technical writing: A fairy taleLana Brindley
 
10 Reasons why you should not install Linux. Ever
10 Reasons why you should not install Linux. Ever10 Reasons why you should not install Linux. Ever
10 Reasons why you should not install Linux. EverLana Brindley
 

Más de Lana Brindley (10)

Open Source Docs: The Good, The Bad, and the WTF?!
Open Source Docs: The Good, The Bad, and the WTF?!Open Source Docs: The Good, The Bad, and the WTF?!
Open Source Docs: The Good, The Bad, and the WTF?!
 
Open Source Documentation in Four Easy Steps (and one slightly more difficult...
Open Source Documentation in Four Easy Steps (and one slightly more difficult...Open Source Documentation in Four Easy Steps (and one slightly more difficult...
Open Source Documentation in Four Easy Steps (and one slightly more difficult...
 
The Grass is Greener on the Open Side
The Grass is Greener on the Open SideThe Grass is Greener on the Open Side
The Grass is Greener on the Open Side
 
Technical Writing for Hoopy Open Source Froods Who Really Know Where Their To...
Technical Writing for Hoopy Open Source Froods Who Really Know Where Their To...Technical Writing for Hoopy Open Source Froods Who Really Know Where Their To...
Technical Writing for Hoopy Open Source Froods Who Really Know Where Their To...
 
Think It. Make It. Change the World.
Think It. Make It. Change the World.Think It. Make It. Change the World.
Think It. Make It. Change the World.
 
Getting Women into Open Source - The Easy Way
Getting Women into Open Source - The Easy WayGetting Women into Open Source - The Easy Way
Getting Women into Open Source - The Easy Way
 
Writing Beautiful Technical Documentation
Writing Beautiful Technical DocumentationWriting Beautiful Technical Documentation
Writing Beautiful Technical Documentation
 
Getting started With Linux: how NOT to do it.
Getting started With Linux: how NOT to do it.Getting started With Linux: how NOT to do it.
Getting started With Linux: how NOT to do it.
 
Technical writing: A fairy tale
Technical writing: A fairy taleTechnical writing: A fairy tale
Technical writing: A fairy tale
 
10 Reasons why you should not install Linux. Ever
10 Reasons why you should not install Linux. Ever10 Reasons why you should not install Linux. Ever
10 Reasons why you should not install Linux. Ever
 

Último

2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...Martijn de Jong
 
Boost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivityBoost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivityPrincipled Technologies
 
IAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI SolutionsIAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI SolutionsEnterprise Knowledge
 
Histor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slideHistor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slidevu2urc
 
Presentation on how to chat with PDF using ChatGPT code interpreter
Presentation on how to chat with PDF using ChatGPT code interpreterPresentation on how to chat with PDF using ChatGPT code interpreter
Presentation on how to chat with PDF using ChatGPT code interpreternaman860154
 
Handwritten Text Recognition for manuscripts and early printed texts
Handwritten Text Recognition for manuscripts and early printed textsHandwritten Text Recognition for manuscripts and early printed texts
Handwritten Text Recognition for manuscripts and early printed textsMaria Levchenko
 
Unblocking The Main Thread Solving ANRs and Frozen Frames
Unblocking The Main Thread Solving ANRs and Frozen FramesUnblocking The Main Thread Solving ANRs and Frozen Frames
Unblocking The Main Thread Solving ANRs and Frozen FramesSinan KOZAK
 
TrustArc Webinar - Stay Ahead of US State Data Privacy Law Developments
TrustArc Webinar - Stay Ahead of US State Data Privacy Law DevelopmentsTrustArc Webinar - Stay Ahead of US State Data Privacy Law Developments
TrustArc Webinar - Stay Ahead of US State Data Privacy Law DevelopmentsTrustArc
 
The 7 Things I Know About Cyber Security After 25 Years | April 2024
The 7 Things I Know About Cyber Security After 25 Years | April 2024The 7 Things I Know About Cyber Security After 25 Years | April 2024
The 7 Things I Know About Cyber Security After 25 Years | April 2024Rafal Los
 
🐬 The future of MySQL is Postgres 🐘
🐬  The future of MySQL is Postgres   🐘🐬  The future of MySQL is Postgres   🐘
🐬 The future of MySQL is Postgres 🐘RTylerCroy
 
GenCyber Cyber Security Day Presentation
GenCyber Cyber Security Day PresentationGenCyber Cyber Security Day Presentation
GenCyber Cyber Security Day PresentationMichael W. Hawkins
 
CNv6 Instructor Chapter 6 Quality of Service
CNv6 Instructor Chapter 6 Quality of ServiceCNv6 Instructor Chapter 6 Quality of Service
CNv6 Instructor Chapter 6 Quality of Servicegiselly40
 
Partners Life - Insurer Innovation Award 2024
Partners Life - Insurer Innovation Award 2024Partners Life - Insurer Innovation Award 2024
Partners Life - Insurer Innovation Award 2024The Digital Insurer
 
Breaking the Kubernetes Kill Chain: Host Path Mount
Breaking the Kubernetes Kill Chain: Host Path MountBreaking the Kubernetes Kill Chain: Host Path Mount
Breaking the Kubernetes Kill Chain: Host Path MountPuma Security, LLC
 
A Call to Action for Generative AI in 2024
A Call to Action for Generative AI in 2024A Call to Action for Generative AI in 2024
A Call to Action for Generative AI in 2024Results
 
Driving Behavioral Change for Information Management through Data-Driven Gree...
Driving Behavioral Change for Information Management through Data-Driven Gree...Driving Behavioral Change for Information Management through Data-Driven Gree...
Driving Behavioral Change for Information Management through Data-Driven Gree...Enterprise Knowledge
 
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...apidays
 
How to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerHow to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerThousandEyes
 
The Codex of Business Writing Software for Real-World Solutions 2.pptx
The Codex of Business Writing Software for Real-World Solutions 2.pptxThe Codex of Business Writing Software for Real-World Solutions 2.pptx
The Codex of Business Writing Software for Real-World Solutions 2.pptxMalak Abu Hammad
 
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptxEIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptxEarley Information Science
 

Último (20)

2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...
 
Boost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivityBoost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivity
 
IAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI SolutionsIAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI Solutions
 
Histor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slideHistor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slide
 
Presentation on how to chat with PDF using ChatGPT code interpreter
Presentation on how to chat with PDF using ChatGPT code interpreterPresentation on how to chat with PDF using ChatGPT code interpreter
Presentation on how to chat with PDF using ChatGPT code interpreter
 
Handwritten Text Recognition for manuscripts and early printed texts
Handwritten Text Recognition for manuscripts and early printed textsHandwritten Text Recognition for manuscripts and early printed texts
Handwritten Text Recognition for manuscripts and early printed texts
 
Unblocking The Main Thread Solving ANRs and Frozen Frames
Unblocking The Main Thread Solving ANRs and Frozen FramesUnblocking The Main Thread Solving ANRs and Frozen Frames
Unblocking The Main Thread Solving ANRs and Frozen Frames
 
TrustArc Webinar - Stay Ahead of US State Data Privacy Law Developments
TrustArc Webinar - Stay Ahead of US State Data Privacy Law DevelopmentsTrustArc Webinar - Stay Ahead of US State Data Privacy Law Developments
TrustArc Webinar - Stay Ahead of US State Data Privacy Law Developments
 
The 7 Things I Know About Cyber Security After 25 Years | April 2024
The 7 Things I Know About Cyber Security After 25 Years | April 2024The 7 Things I Know About Cyber Security After 25 Years | April 2024
The 7 Things I Know About Cyber Security After 25 Years | April 2024
 
🐬 The future of MySQL is Postgres 🐘
🐬  The future of MySQL is Postgres   🐘🐬  The future of MySQL is Postgres   🐘
🐬 The future of MySQL is Postgres 🐘
 
GenCyber Cyber Security Day Presentation
GenCyber Cyber Security Day PresentationGenCyber Cyber Security Day Presentation
GenCyber Cyber Security Day Presentation
 
CNv6 Instructor Chapter 6 Quality of Service
CNv6 Instructor Chapter 6 Quality of ServiceCNv6 Instructor Chapter 6 Quality of Service
CNv6 Instructor Chapter 6 Quality of Service
 
Partners Life - Insurer Innovation Award 2024
Partners Life - Insurer Innovation Award 2024Partners Life - Insurer Innovation Award 2024
Partners Life - Insurer Innovation Award 2024
 
Breaking the Kubernetes Kill Chain: Host Path Mount
Breaking the Kubernetes Kill Chain: Host Path MountBreaking the Kubernetes Kill Chain: Host Path Mount
Breaking the Kubernetes Kill Chain: Host Path Mount
 
A Call to Action for Generative AI in 2024
A Call to Action for Generative AI in 2024A Call to Action for Generative AI in 2024
A Call to Action for Generative AI in 2024
 
Driving Behavioral Change for Information Management through Data-Driven Gree...
Driving Behavioral Change for Information Management through Data-Driven Gree...Driving Behavioral Change for Information Management through Data-Driven Gree...
Driving Behavioral Change for Information Management through Data-Driven Gree...
 
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
 
How to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerHow to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected Worker
 
The Codex of Business Writing Software for Real-World Solutions 2.pptx
The Codex of Business Writing Software for Real-World Solutions 2.pptxThe Codex of Business Writing Software for Real-World Solutions 2.pptx
The Codex of Business Writing Software for Real-World Solutions 2.pptx
 
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptxEIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
 

Confessions of a Technical Writer