SlideShare une entreprise Scribd logo
1  sur  1
Writing Documentation That Matters
Writing to Address the Specific Needs of Your Audience
Answer these questions as the first step in any writing/documentation task.
Why am I writing this?
What do I want the reader to do (or be able to do)?
Who exactly is my reader? Do I have more than one?
What is the reader’s role? Decision-maker? Influencer? Implementer? Other?
What does the reader already knowabout the subject?
Does the reader have any preconceived notions about the documentation?
What’s in it for the reader? Why should the reader even bother reading?
Howwill the reader use this document? One-time read? Or a frequently used reference material?
Good writers make the reader feel smart—are you making the reader feel smart?
What is ultimately the best way to connect with your audience?

Contenu connexe

En vedette

Scenario exercise 2014 mid atlantic technical communication conference DDeBoard
Scenario exercise 2014 mid atlantic technical communication conference DDeBoardScenario exercise 2014 mid atlantic technical communication conference DDeBoard
Scenario exercise 2014 mid atlantic technical communication conference DDeBoardddeboard
 
Seeking Sunshine in Cloud Technology - STC PMC 2014
Seeking Sunshine in Cloud Technology - STC PMC 2014Seeking Sunshine in Cloud Technology - STC PMC 2014
Seeking Sunshine in Cloud Technology - STC PMC 2014Roger Renteria
 
Mastering LinkedIn: Professional identity, insights, everywhere
Mastering LinkedIn: Professional identity, insights, everywhereMastering LinkedIn: Professional identity, insights, everywhere
Mastering LinkedIn: Professional identity, insights, everywhereBarrie Byron
 
DDeBoard Customer Journey Maps: Visualizing an engaging customer experience S...
DDeBoard Customer Journey Maps: Visualizing an engaging customer experience S...DDeBoard Customer Journey Maps: Visualizing an engaging customer experience S...
DDeBoard Customer Journey Maps: Visualizing an engaging customer experience S...ddeboard
 
So You Want to Be a Content Strategist?
So You Want to Be a Content Strategist?So You Want to Be a Content Strategist?
So You Want to Be a Content Strategist?David Dylan Thomas
 
Scenario based design 2014 mid atlantic conference Donn DeBoard
Scenario based design 2014 mid atlantic conference Donn DeBoardScenario based design 2014 mid atlantic conference Donn DeBoard
Scenario based design 2014 mid atlantic conference Donn DeBoardddeboard
 
DDeBoard Lego Customer Journey Map Example (Hoystn) STC Philadelphia Metro Ch...
DDeBoard Lego Customer Journey Map Example (Hoystn) STC Philadelphia Metro Ch...DDeBoard Lego Customer Journey Map Example (Hoystn) STC Philadelphia Metro Ch...
DDeBoard Lego Customer Journey Map Example (Hoystn) STC Philadelphia Metro Ch...ddeboard
 
Links as Language: A Contextual Approach to Content Creation
Links as Language: A Contextual Approach to Content CreationLinks as Language: A Contextual Approach to Content Creation
Links as Language: A Contextual Approach to Content CreationDavid Dylan Thomas
 
DDeBoard Rail Europe Journey Map Exercise STC Philadelphia Metro Chapter Apri...
DDeBoard Rail Europe Journey Map Exercise STC Philadelphia Metro Chapter Apri...DDeBoard Rail Europe Journey Map Exercise STC Philadelphia Metro Chapter Apri...
DDeBoard Rail Europe Journey Map Exercise STC Philadelphia Metro Chapter Apri...ddeboard
 

En vedette (18)

STC-PMC 2009 Conference Flyer
STC-PMC 2009 Conference FlyerSTC-PMC 2009 Conference Flyer
STC-PMC 2009 Conference Flyer
 
Scenario exercise 2014 mid atlantic technical communication conference DDeBoard
Scenario exercise 2014 mid atlantic technical communication conference DDeBoardScenario exercise 2014 mid atlantic technical communication conference DDeBoard
Scenario exercise 2014 mid atlantic technical communication conference DDeBoard
 
Seeking Sunshine in Cloud Technology - STC PMC 2014
Seeking Sunshine in Cloud Technology - STC PMC 2014Seeking Sunshine in Cloud Technology - STC PMC 2014
Seeking Sunshine in Cloud Technology - STC PMC 2014
 
2012 STC-PMC Conference Workshop Flyer
2012 STC-PMC Conference Workshop Flyer2012 STC-PMC Conference Workshop Flyer
2012 STC-PMC Conference Workshop Flyer
 
Federal Jobs Handout 2013
Federal Jobs Handout 2013Federal Jobs Handout 2013
Federal Jobs Handout 2013
 
Tips for Tech Communication Job Seekers
Tips for Tech Communication Job SeekersTips for Tech Communication Job Seekers
Tips for Tech Communication Job Seekers
 
Mastering LinkedIn: Professional identity, insights, everywhere
Mastering LinkedIn: Professional identity, insights, everywhereMastering LinkedIn: Professional identity, insights, everywhere
Mastering LinkedIn: Professional identity, insights, everywhere
 
DDeBoard Customer Journey Maps: Visualizing an engaging customer experience S...
DDeBoard Customer Journey Maps: Visualizing an engaging customer experience S...DDeBoard Customer Journey Maps: Visualizing an engaging customer experience S...
DDeBoard Customer Journey Maps: Visualizing an engaging customer experience S...
 
Empowering the Introvert Within stc13
Empowering the Introvert Within stc13Empowering the Introvert Within stc13
Empowering the Introvert Within stc13
 
So You Want to Be a Content Strategist?
So You Want to Be a Content Strategist?So You Want to Be a Content Strategist?
So You Want to Be a Content Strategist?
 
Scenario based design 2014 mid atlantic conference Donn DeBoard
Scenario based design 2014 mid atlantic conference Donn DeBoardScenario based design 2014 mid atlantic conference Donn DeBoard
Scenario based design 2014 mid atlantic conference Donn DeBoard
 
DDeBoard Lego Customer Journey Map Example (Hoystn) STC Philadelphia Metro Ch...
DDeBoard Lego Customer Journey Map Example (Hoystn) STC Philadelphia Metro Ch...DDeBoard Lego Customer Journey Map Example (Hoystn) STC Philadelphia Metro Ch...
DDeBoard Lego Customer Journey Map Example (Hoystn) STC Philadelphia Metro Ch...
 
Links as Language: A Contextual Approach to Content Creation
Links as Language: A Contextual Approach to Content CreationLinks as Language: A Contextual Approach to Content Creation
Links as Language: A Contextual Approach to Content Creation
 
DDeBoard Rail Europe Journey Map Exercise STC Philadelphia Metro Chapter Apri...
DDeBoard Rail Europe Journey Map Exercise STC Philadelphia Metro Chapter Apri...DDeBoard Rail Europe Journey Map Exercise STC Philadelphia Metro Chapter Apri...
DDeBoard Rail Europe Journey Map Exercise STC Philadelphia Metro Chapter Apri...
 
2014 Technical Communication Conference Program
2014 Technical Communication Conference Program2014 Technical Communication Conference Program
2014 Technical Communication Conference Program
 
Five+ Ways to Add Interactivity to Online Help
Five+ Ways to Add Interactivity to Online HelpFive+ Ways to Add Interactivity to Online Help
Five+ Ways to Add Interactivity to Online Help
 
Writing for the FDA
Writing for the FDAWriting for the FDA
Writing for the FDA
 
Becoming a STAR Candidate
Becoming a STAR CandidateBecoming a STAR Candidate
Becoming a STAR Candidate
 

Plus de STC-Philadelphia Metro Chapter

From Multimedia to Social Media to Augmented and Virtual Reality April 2019
From Multimedia to Social Media to Augmented and Virtual Reality April 2019From Multimedia to Social Media to Augmented and Virtual Reality April 2019
From Multimedia to Social Media to Augmented and Virtual Reality April 2019STC-Philadelphia Metro Chapter
 
March 2018 STC-PMC Webinar: Millennial Documentation (Presented by Pooja Vija...
March 2018 STC-PMC Webinar: Millennial Documentation (Presented by Pooja Vija...March 2018 STC-PMC Webinar: Millennial Documentation (Presented by Pooja Vija...
March 2018 STC-PMC Webinar: Millennial Documentation (Presented by Pooja Vija...STC-Philadelphia Metro Chapter
 
The Cost of Doing Nothing (By Suzanne Mescan of Vasont)
The Cost of Doing Nothing (By Suzanne Mescan of Vasont)The Cost of Doing Nothing (By Suzanne Mescan of Vasont)
The Cost of Doing Nothing (By Suzanne Mescan of Vasont)STC-Philadelphia Metro Chapter
 
7 Lessons from the Future of Content (By David Dylan Thomas)
7 Lessons from the Future of Content (By David Dylan Thomas)7 Lessons from the Future of Content (By David Dylan Thomas)
7 Lessons from the Future of Content (By David Dylan Thomas)STC-Philadelphia Metro Chapter
 
Effectively Telling Your Story through Content Marketing
Effectively Telling Your Story through Content MarketingEffectively Telling Your Story through Content Marketing
Effectively Telling Your Story through Content MarketingSTC-Philadelphia Metro Chapter
 
Defining New Roles for Information Engineering in the Customer Content Journey
Defining New Roles for Information Engineering in the Customer Content JourneyDefining New Roles for Information Engineering in the Customer Content Journey
Defining New Roles for Information Engineering in the Customer Content JourneySTC-Philadelphia Metro Chapter
 
We’re Going Mobile! Great! Wait… What Does That Mean?
We’re Going Mobile! Great! Wait… What Does That Mean?We’re Going Mobile! Great! Wait… What Does That Mean?
We’re Going Mobile! Great! Wait… What Does That Mean?STC-Philadelphia Metro Chapter
 
STC-PMC November 2016 Presentation - Mobile First Content
STC-PMC November 2016 Presentation - Mobile First ContentSTC-PMC November 2016 Presentation - Mobile First Content
STC-PMC November 2016 Presentation - Mobile First ContentSTC-Philadelphia Metro Chapter
 
STC-PMC October 2016 Presentation-That's What You Think!
STC-PMC October 2016 Presentation-That's What You Think!STC-PMC October 2016 Presentation-That's What You Think!
STC-PMC October 2016 Presentation-That's What You Think!STC-Philadelphia Metro Chapter
 
Public Speaking Skills: A Project Manager’s Best Friend
Public Speaking Skills: A Project Manager’s Best FriendPublic Speaking Skills: A Project Manager’s Best Friend
Public Speaking Skills: A Project Manager’s Best FriendSTC-Philadelphia Metro Chapter
 
Just Think About This - 9 Thinking Modalities to Consider
Just Think About This - 9 Thinking Modalities to ConsiderJust Think About This - 9 Thinking Modalities to Consider
Just Think About This - 9 Thinking Modalities to ConsiderSTC-Philadelphia Metro Chapter
 

Plus de STC-Philadelphia Metro Chapter (20)

From Multimedia to Social Media to Augmented and Virtual Reality April 2019
From Multimedia to Social Media to Augmented and Virtual Reality April 2019From Multimedia to Social Media to Augmented and Virtual Reality April 2019
From Multimedia to Social Media to Augmented and Virtual Reality April 2019
 
March 2018 STC-PMC Webinar: Millennial Documentation (Presented by Pooja Vija...
March 2018 STC-PMC Webinar: Millennial Documentation (Presented by Pooja Vija...March 2018 STC-PMC Webinar: Millennial Documentation (Presented by Pooja Vija...
March 2018 STC-PMC Webinar: Millennial Documentation (Presented by Pooja Vija...
 
Networking for Geeks (by Brian Winter)
Networking for Geeks (by Brian Winter)Networking for Geeks (by Brian Winter)
Networking for Geeks (by Brian Winter)
 
The Cost of Doing Nothing (By Suzanne Mescan of Vasont)
The Cost of Doing Nothing (By Suzanne Mescan of Vasont)The Cost of Doing Nothing (By Suzanne Mescan of Vasont)
The Cost of Doing Nothing (By Suzanne Mescan of Vasont)
 
Markup For Dummies (Russ Ward)
Markup For Dummies (Russ Ward)Markup For Dummies (Russ Ward)
Markup For Dummies (Russ Ward)
 
Why is My Team Failing? (By Christine Loch)
Why is My Team Failing? (By Christine Loch)Why is My Team Failing? (By Christine Loch)
Why is My Team Failing? (By Christine Loch)
 
7 Lessons from the Future of Content (By David Dylan Thomas)
7 Lessons from the Future of Content (By David Dylan Thomas)7 Lessons from the Future of Content (By David Dylan Thomas)
7 Lessons from the Future of Content (By David Dylan Thomas)
 
Content Marketing Resource List
Content Marketing Resource ListContent Marketing Resource List
Content Marketing Resource List
 
Managing the MarComm/TechComm Showdown
Managing the MarComm/TechComm ShowdownManaging the MarComm/TechComm Showdown
Managing the MarComm/TechComm Showdown
 
Effectively Telling Your Story through Content Marketing
Effectively Telling Your Story through Content MarketingEffectively Telling Your Story through Content Marketing
Effectively Telling Your Story through Content Marketing
 
Defining New Roles for Information Engineering in the Customer Content Journey
Defining New Roles for Information Engineering in the Customer Content JourneyDefining New Roles for Information Engineering in the Customer Content Journey
Defining New Roles for Information Engineering in the Customer Content Journey
 
We’re Going Mobile! Great! Wait… What Does That Mean?
We’re Going Mobile! Great! Wait… What Does That Mean?We’re Going Mobile! Great! Wait… What Does That Mean?
We’re Going Mobile! Great! Wait… What Does That Mean?
 
GitHub Workflows for Technical Communication
GitHub Workflows for Technical CommunicationGitHub Workflows for Technical Communication
GitHub Workflows for Technical Communication
 
STC-PMC November 2016 Presentation - Mobile First Content
STC-PMC November 2016 Presentation - Mobile First ContentSTC-PMC November 2016 Presentation - Mobile First Content
STC-PMC November 2016 Presentation - Mobile First Content
 
STC-PMC October 2016 Presentation-That's What You Think!
STC-PMC October 2016 Presentation-That's What You Think!STC-PMC October 2016 Presentation-That's What You Think!
STC-PMC October 2016 Presentation-That's What You Think!
 
2016 Conduit Program
2016 Conduit Program2016 Conduit Program
2016 Conduit Program
 
Video Tools in Tech Writing
Video Tools in Tech WritingVideo Tools in Tech Writing
Video Tools in Tech Writing
 
UX and Cognitive Load
UX and Cognitive LoadUX and Cognitive Load
UX and Cognitive Load
 
Public Speaking Skills: A Project Manager’s Best Friend
Public Speaking Skills: A Project Manager’s Best FriendPublic Speaking Skills: A Project Manager’s Best Friend
Public Speaking Skills: A Project Manager’s Best Friend
 
Just Think About This - 9 Thinking Modalities to Consider
Just Think About This - 9 Thinking Modalities to ConsiderJust Think About This - 9 Thinking Modalities to Consider
Just Think About This - 9 Thinking Modalities to Consider
 

Dernier

Barangay Council for the Protection of Children (BCPC) Orientation.pptx
Barangay Council for the Protection of Children (BCPC) Orientation.pptxBarangay Council for the Protection of Children (BCPC) Orientation.pptx
Barangay Council for the Protection of Children (BCPC) Orientation.pptxCarlos105
 
Student Profile Sample - We help schools to connect the data they have, with ...
Student Profile Sample - We help schools to connect the data they have, with ...Student Profile Sample - We help schools to connect the data they have, with ...
Student Profile Sample - We help schools to connect the data they have, with ...Seán Kennedy
 
Transaction Management in Database Management System
Transaction Management in Database Management SystemTransaction Management in Database Management System
Transaction Management in Database Management SystemChristalin Nelson
 
Karra SKD Conference Presentation Revised.pptx
Karra SKD Conference Presentation Revised.pptxKarra SKD Conference Presentation Revised.pptx
Karra SKD Conference Presentation Revised.pptxAshokKarra1
 
INTRODUCTION TO CATHOLIC CHRISTOLOGY.pptx
INTRODUCTION TO CATHOLIC CHRISTOLOGY.pptxINTRODUCTION TO CATHOLIC CHRISTOLOGY.pptx
INTRODUCTION TO CATHOLIC CHRISTOLOGY.pptxHumphrey A Beña
 
How to do quick user assign in kanban in Odoo 17 ERP
How to do quick user assign in kanban in Odoo 17 ERPHow to do quick user assign in kanban in Odoo 17 ERP
How to do quick user assign in kanban in Odoo 17 ERPCeline George
 
Virtual-Orientation-on-the-Administration-of-NATG12-NATG6-and-ELLNA.pdf
Virtual-Orientation-on-the-Administration-of-NATG12-NATG6-and-ELLNA.pdfVirtual-Orientation-on-the-Administration-of-NATG12-NATG6-and-ELLNA.pdf
Virtual-Orientation-on-the-Administration-of-NATG12-NATG6-and-ELLNA.pdfErwinPantujan2
 
Incoming and Outgoing Shipments in 3 STEPS Using Odoo 17
Incoming and Outgoing Shipments in 3 STEPS Using Odoo 17Incoming and Outgoing Shipments in 3 STEPS Using Odoo 17
Incoming and Outgoing Shipments in 3 STEPS Using Odoo 17Celine George
 
ENGLISH 7_Q4_LESSON 2_ Employing a Variety of Strategies for Effective Interp...
ENGLISH 7_Q4_LESSON 2_ Employing a Variety of Strategies for Effective Interp...ENGLISH 7_Q4_LESSON 2_ Employing a Variety of Strategies for Effective Interp...
ENGLISH 7_Q4_LESSON 2_ Employing a Variety of Strategies for Effective Interp...JhezDiaz1
 
4.16.24 Poverty and Precarity--Desmond.pptx
4.16.24 Poverty and Precarity--Desmond.pptx4.16.24 Poverty and Precarity--Desmond.pptx
4.16.24 Poverty and Precarity--Desmond.pptxmary850239
 
ECONOMIC CONTEXT - PAPER 1 Q3: NEWSPAPERS.pptx
ECONOMIC CONTEXT - PAPER 1 Q3: NEWSPAPERS.pptxECONOMIC CONTEXT - PAPER 1 Q3: NEWSPAPERS.pptx
ECONOMIC CONTEXT - PAPER 1 Q3: NEWSPAPERS.pptxiammrhaywood
 
AUDIENCE THEORY -CULTIVATION THEORY - GERBNER.pptx
AUDIENCE THEORY -CULTIVATION THEORY -  GERBNER.pptxAUDIENCE THEORY -CULTIVATION THEORY -  GERBNER.pptx
AUDIENCE THEORY -CULTIVATION THEORY - GERBNER.pptxiammrhaywood
 
Active Learning Strategies (in short ALS).pdf
Active Learning Strategies (in short ALS).pdfActive Learning Strategies (in short ALS).pdf
Active Learning Strategies (in short ALS).pdfPatidar M
 
Influencing policy (training slides from Fast Track Impact)
Influencing policy (training slides from Fast Track Impact)Influencing policy (training slides from Fast Track Impact)
Influencing policy (training slides from Fast Track Impact)Mark Reed
 
Difference Between Search & Browse Methods in Odoo 17
Difference Between Search & Browse Methods in Odoo 17Difference Between Search & Browse Methods in Odoo 17
Difference Between Search & Browse Methods in Odoo 17Celine George
 
Activity 2-unit 2-update 2024. English translation
Activity 2-unit 2-update 2024. English translationActivity 2-unit 2-update 2024. English translation
Activity 2-unit 2-update 2024. English translationRosabel UA
 
Integumentary System SMP B. Pharm Sem I.ppt
Integumentary System SMP B. Pharm Sem I.pptIntegumentary System SMP B. Pharm Sem I.ppt
Integumentary System SMP B. Pharm Sem I.pptshraddhaparab530
 
Inclusivity Essentials_ Creating Accessible Websites for Nonprofits .pdf
Inclusivity Essentials_ Creating Accessible Websites for Nonprofits .pdfInclusivity Essentials_ Creating Accessible Websites for Nonprofits .pdf
Inclusivity Essentials_ Creating Accessible Websites for Nonprofits .pdfTechSoup
 

Dernier (20)

Barangay Council for the Protection of Children (BCPC) Orientation.pptx
Barangay Council for the Protection of Children (BCPC) Orientation.pptxBarangay Council for the Protection of Children (BCPC) Orientation.pptx
Barangay Council for the Protection of Children (BCPC) Orientation.pptx
 
Student Profile Sample - We help schools to connect the data they have, with ...
Student Profile Sample - We help schools to connect the data they have, with ...Student Profile Sample - We help schools to connect the data they have, with ...
Student Profile Sample - We help schools to connect the data they have, with ...
 
Transaction Management in Database Management System
Transaction Management in Database Management SystemTransaction Management in Database Management System
Transaction Management in Database Management System
 
Karra SKD Conference Presentation Revised.pptx
Karra SKD Conference Presentation Revised.pptxKarra SKD Conference Presentation Revised.pptx
Karra SKD Conference Presentation Revised.pptx
 
INTRODUCTION TO CATHOLIC CHRISTOLOGY.pptx
INTRODUCTION TO CATHOLIC CHRISTOLOGY.pptxINTRODUCTION TO CATHOLIC CHRISTOLOGY.pptx
INTRODUCTION TO CATHOLIC CHRISTOLOGY.pptx
 
How to do quick user assign in kanban in Odoo 17 ERP
How to do quick user assign in kanban in Odoo 17 ERPHow to do quick user assign in kanban in Odoo 17 ERP
How to do quick user assign in kanban in Odoo 17 ERP
 
Virtual-Orientation-on-the-Administration-of-NATG12-NATG6-and-ELLNA.pdf
Virtual-Orientation-on-the-Administration-of-NATG12-NATG6-and-ELLNA.pdfVirtual-Orientation-on-the-Administration-of-NATG12-NATG6-and-ELLNA.pdf
Virtual-Orientation-on-the-Administration-of-NATG12-NATG6-and-ELLNA.pdf
 
Incoming and Outgoing Shipments in 3 STEPS Using Odoo 17
Incoming and Outgoing Shipments in 3 STEPS Using Odoo 17Incoming and Outgoing Shipments in 3 STEPS Using Odoo 17
Incoming and Outgoing Shipments in 3 STEPS Using Odoo 17
 
ENGLISH 7_Q4_LESSON 2_ Employing a Variety of Strategies for Effective Interp...
ENGLISH 7_Q4_LESSON 2_ Employing a Variety of Strategies for Effective Interp...ENGLISH 7_Q4_LESSON 2_ Employing a Variety of Strategies for Effective Interp...
ENGLISH 7_Q4_LESSON 2_ Employing a Variety of Strategies for Effective Interp...
 
4.16.24 Poverty and Precarity--Desmond.pptx
4.16.24 Poverty and Precarity--Desmond.pptx4.16.24 Poverty and Precarity--Desmond.pptx
4.16.24 Poverty and Precarity--Desmond.pptx
 
ECONOMIC CONTEXT - PAPER 1 Q3: NEWSPAPERS.pptx
ECONOMIC CONTEXT - PAPER 1 Q3: NEWSPAPERS.pptxECONOMIC CONTEXT - PAPER 1 Q3: NEWSPAPERS.pptx
ECONOMIC CONTEXT - PAPER 1 Q3: NEWSPAPERS.pptx
 
AUDIENCE THEORY -CULTIVATION THEORY - GERBNER.pptx
AUDIENCE THEORY -CULTIVATION THEORY -  GERBNER.pptxAUDIENCE THEORY -CULTIVATION THEORY -  GERBNER.pptx
AUDIENCE THEORY -CULTIVATION THEORY - GERBNER.pptx
 
LEFT_ON_C'N_ PRELIMS_EL_DORADO_2024.pptx
LEFT_ON_C'N_ PRELIMS_EL_DORADO_2024.pptxLEFT_ON_C'N_ PRELIMS_EL_DORADO_2024.pptx
LEFT_ON_C'N_ PRELIMS_EL_DORADO_2024.pptx
 
Active Learning Strategies (in short ALS).pdf
Active Learning Strategies (in short ALS).pdfActive Learning Strategies (in short ALS).pdf
Active Learning Strategies (in short ALS).pdf
 
Influencing policy (training slides from Fast Track Impact)
Influencing policy (training slides from Fast Track Impact)Influencing policy (training slides from Fast Track Impact)
Influencing policy (training slides from Fast Track Impact)
 
Difference Between Search & Browse Methods in Odoo 17
Difference Between Search & Browse Methods in Odoo 17Difference Between Search & Browse Methods in Odoo 17
Difference Between Search & Browse Methods in Odoo 17
 
Activity 2-unit 2-update 2024. English translation
Activity 2-unit 2-update 2024. English translationActivity 2-unit 2-update 2024. English translation
Activity 2-unit 2-update 2024. English translation
 
Integumentary System SMP B. Pharm Sem I.ppt
Integumentary System SMP B. Pharm Sem I.pptIntegumentary System SMP B. Pharm Sem I.ppt
Integumentary System SMP B. Pharm Sem I.ppt
 
Raw materials used in Herbal Cosmetics.pptx
Raw materials used in Herbal Cosmetics.pptxRaw materials used in Herbal Cosmetics.pptx
Raw materials used in Herbal Cosmetics.pptx
 
Inclusivity Essentials_ Creating Accessible Websites for Nonprofits .pdf
Inclusivity Essentials_ Creating Accessible Websites for Nonprofits .pdfInclusivity Essentials_ Creating Accessible Websites for Nonprofits .pdf
Inclusivity Essentials_ Creating Accessible Websites for Nonprofits .pdf
 

Writing Documentation that Matters

  • 1. Writing Documentation That Matters Writing to Address the Specific Needs of Your Audience Answer these questions as the first step in any writing/documentation task. Why am I writing this? What do I want the reader to do (or be able to do)? Who exactly is my reader? Do I have more than one? What is the reader’s role? Decision-maker? Influencer? Implementer? Other? What does the reader already knowabout the subject? Does the reader have any preconceived notions about the documentation? What’s in it for the reader? Why should the reader even bother reading? Howwill the reader use this document? One-time read? Or a frequently used reference material? Good writers make the reader feel smart—are you making the reader feel smart? What is ultimately the best way to connect with your audience?