SlideShare una empresa de Scribd logo
1 de 24
• Technical communications leader
• 32 years of technical documentation
experience
• Led writing teams at 6 US companies
• Founded Saiff Solutions, Inc. in 2011
• Provides content development to
Fortune 500 companies in Japan & US
• Loves acronyms
About the Speaker: Barry Saiff
AGEND
A
Vision
DON’T TAKE IT PERSONALLY a .
(learn)
7 Habits of Highly Effective
Technical Writers
1
LEARN BEFORE ASKING
(respect, impress)
2
ASK .
(often)
3
REWRITE
(always)
4
ACQUIRE FEEDBACK
(test, reviews)
5
UNDERSTAND
(before publishing)
6
CONTRIBUTE7
Vision
1. DON’T TAKE IT
PERSONALLY (learn)
Great technical writers thrive on criticism. They
understand that it enables them to improve,
and to improve the accuracy and readability of
their content. So, don’t take criticism personally.
Use it to your advantage.
Vision
Learn as much as you can from available
resources before asking questions. In this
way, you can respect others’ time and
impress your colleagues with your ability
to ask intelligent questions.
2. LEARN BEFORE ASKING
(respect, impress)
Vision
Technical writing requires good people
skills. Don’t attempt it alone.
Ask questions. Ask for help.
3. ASK
(often)
Vision
Pick 3 of your favorite writers. If you were
able to see their first drafts, you’d
probably think, “I can do much better.”
The best writers in the world are the best
re-writers. Always rewrite, rewrite, and
rewrite some more.
4. REWRITE
(always)
Vision
Technical writing is almost never 100% on
the first draft. Without adequate testing
and review, accuracy is often unattainable.
Make sure you get the feedback you need
to excel.
5. ACQUIRE FEEDBACK
(test, reviews)
Vision
When you start, you may not fully understand your
subject matter. That’s fine. By the time you publish,
make sure you do understand. If you don’t understand
what you write, your readers are not likely to
understand it, either.
If you write something, you need to understand what
you wrote. Even if it is just a draft to show your editor,
you need to either a) fully understand what you wrote,
or b) have a list of questions. Do not write a sentence
that you yourself do not understand.
6. UNDERSTAND
(before publishing)
Vision
Notice things. Does the prototype work
as expected?
Are the user interface labels capitalized
consistently?
Ask questions. Make suggestions.
Be a part of the product team.
7. CONTRIBUTE
Vision
BE A CUSTOMER
ADVOCATE
7 Habits of Highly Effective
Technical Communications Leaders
8
ADVOCATE FOR PROCESS
IMPROVEMENTS9
CARE ABOUT ALL
CUSTOMER-VISIBLE
CONTENT
10
BE AN EFFECTIVE
INTRAPRENEUR11
KNOW YOUR AUDIENCE12
PROMOTE APPROPRIATE
TECHNICAL COMMUNICATIONS
METHODOLOGIES, GENTLY
13
KEEP
PERSPECTIVE, AND
DE-STRESS
14
Vision
7 Habits of Highly Effective
Technical Communications Leaders
You can be an effective leader, regardless of your position.
These 7 habits go beyond the basics of developing good content,
to answer this question:
As a technical communications leader, at any level, how do you
influence the work environment, improve the processes, and
educate the people to make continuous improvement possible?
Vision
While you may have less product knowledge
than an engineer, you can view the product
from a user’s perspective. Share your input
and advocate for product and process
improvements. Support similar efforts
initiated by others. Focus on quality.
8. BE A CUSTOMER
ADVOCATE
Vision
Process improvements can benefit everyone on
the team, and improve product quality. Can the
quality assurance team test the documentation?
Can technical writers edit the user interface text
and error messages? Can written documentation
reviews become a factor in the performance
evaluations of all product team members?
Would documentation review meetings improve
quality?
9. ADVOCATE FOR PROCESS
IMPROVEMENTS
Vision
If you’re only writing the customer
documentation, there is a chance that no one
with your skills is editing other user-visible
content. Even if you cannot edit this content,
you can educate others about key technical
writing practices. For example – One concept,
One term – each word should be used to mean
only one thing. This avoids user confusion, and
saves translation funds. Another key technical
writing practice: short sentences.
10. CARE ABOUT ALL
CUSTOMER-VISIBLE CONTENT
Vision
Think about how to create change – look before
you leap. Understand the who, what, and how of
change. Who are the key stakeholders and
decision-makers, and what motivates them?
What do they care about? How can you best
bring them on board? What are their
backgrounds – cultural, professional,
educational? Start with curiosity. Listen. Discuss.
Ask questions.
11. BE AN EFFECTIVE
INTRAPRENEUR
What do you know about the users – education
levels, roles? How do they use the product and
access the documentation? What percentage
read the documentation in English?
Collaborative efforts with other teams can aid
your research. One way to learn more is to
conduct a user survey. While gaining approval
can be an uphill battle, the insights gained from
a well-designed survey can make the effort
worthwhile.
Vision12. KNOW YOU AUDIENCE
Vision
Not every organization needs to use the latest
methodologies. What worked elsewhere may
not work for your team. Bring others along with
you – educate and involve engineers, quality
assurance personnel, marketers, and product
managers in assessing and exploring new
methodologies. For example, some
organizations can benefit from adopting topic-
based authoring, without XML or DITA.
13. PROMOTE APPROPRIATE TECHNICAL
COMMUNICATIONS METHODOLOGIES, GENTLY
Vision
Mistakes provide tremendous opportunities for
personal and organizational growth, including
improved processes, communications, and skills.
Accept these moments and make the most of them.
Learn from successes and failures. Remember that
what is truly irreplaceable is human life. Learn what
you need, and what your coworkers need, to reduce
and relieve stress.
14. KEEP PERSPECTIVE,
AND DE-STRESS
Vision
7 Habits of Highly Effective
Technical Communications Leaders
Consistently practicing these 7 habits will support your development as an
effective technical communications leader, continuous process
improvement in your organization, harmonious work relationships, and
improved content and product quality. Be the change you wish to see.
BONUS: Resources
• BALANCE infographic (Respect) – We will send it, with the
presentation, to all webinar registrants.
• Global Content Creation – Making it Work
• A Motivating SLAP
• The 21 Dimensions of Respect for Foreigners
• 2016 New Years Free Gifts
• What do good technical writers do? Why do we need them?
Email: barrysaiff@saiffsolutions.com
Skype: SaiffSolutions
Contact: +1 415 350 2959
+63 917 872 0929
Web: www.saiffsolutions.com
Join us at:
LavaCon Las Vegas, October 26-29: http://lavacon.org/2016/vegas/
ALL QUESTIONS ARE WELCOME!
BONUS: Creativity in the Face of
Stress
A good manager creates and protects a healthy culture.
Culture lives in the details. In every moment, every
action and interaction.
Think about how you deal with stress. You are a role
model for your team.
Successful managers rely on the 3 Cs:
Caring, Competence, and Creativity

Más contenido relacionado

La actualidad más candente

Professional Skills to a Successful Career
Professional Skills to a Successful CareerProfessional Skills to a Successful Career
Professional Skills to a Successful CareerEdward Erasmus
 
Introduction to Professional Development 231112
Introduction to Professional Development 231112Introduction to Professional Development 231112
Introduction to Professional Development 231112Kamal Vora
 
From Real to Ideal: Envisioning and Moving Toward Your Best Culture [Culture ...
From Real to Ideal: Envisioning and Moving Toward Your Best Culture [Culture ...From Real to Ideal: Envisioning and Moving Toward Your Best Culture [Culture ...
From Real to Ideal: Envisioning and Moving Toward Your Best Culture [Culture ...Delivering Happiness
 
Johns Hopkins Innovation Factory - Entrepreneur Development Program #1
Johns Hopkins Innovation Factory - Entrepreneur Development Program #1Johns Hopkins Innovation Factory - Entrepreneur Development Program #1
Johns Hopkins Innovation Factory - Entrepreneur Development Program #1Glenn Alpert
 
Johns hopkins innovation factory entrepreneur development program #5
Johns hopkins innovation factory entrepreneur development program #5Johns hopkins innovation factory entrepreneur development program #5
Johns hopkins innovation factory entrepreneur development program #5Glenn Alpert
 
Breaking the Code of Interview Implicit Bias to Value Different Gender Compet...
Breaking the Code of Interview Implicit Bias to Value Different Gender Compet...Breaking the Code of Interview Implicit Bias to Value Different Gender Compet...
Breaking the Code of Interview Implicit Bias to Value Different Gender Compet...Deanna Kosaraju
 
Johns Hopkins Innovation Factory - Entrepreneur Development Program #2
Johns Hopkins Innovation Factory - Entrepreneur Development Program #2Johns Hopkins Innovation Factory - Entrepreneur Development Program #2
Johns Hopkins Innovation Factory - Entrepreneur Development Program #2Glenn Alpert
 
Johns hopkins innovation factory entrepreneur development program #3
Johns hopkins innovation factory   entrepreneur development program #3Johns hopkins innovation factory   entrepreneur development program #3
Johns hopkins innovation factory entrepreneur development program #3Glenn Alpert
 
Remarkable: Proven Insights to Accelerate Your Career
Remarkable: Proven Insights to Accelerate Your CareerRemarkable: Proven Insights to Accelerate Your Career
Remarkable: Proven Insights to Accelerate Your CareerDavid Kronfeld
 
Short Guide to Productivity
Short Guide to ProductivityShort Guide to Productivity
Short Guide to ProductivityStephan Schmidt
 
Documentation Leadership: Dealing with People Issues in Technical Documentation
Documentation Leadership: Dealing with People Issues in Technical DocumentationDocumentation Leadership: Dealing with People Issues in Technical Documentation
Documentation Leadership: Dealing with People Issues in Technical DocumentationSaiff Solutions, Inc.
 
Coaching For Optimal Performance
Coaching For Optimal Performance   Coaching For Optimal Performance
Coaching For Optimal Performance Yodhia Antariksa
 
25-TC - Presentation Skills deck v2 10.29.2015
25-TC - Presentation Skills deck v2 10.29.201525-TC - Presentation Skills deck v2 10.29.2015
25-TC - Presentation Skills deck v2 10.29.2015Danielle Kautz
 
Agile soft skills suitecase - iad 2011
Agile soft skills suitecase - iad 2011Agile soft skills suitecase - iad 2011
Agile soft skills suitecase - iad 2011Fabio Armani
 

La actualidad más candente (20)

Professional Skills to a Successful Career
Professional Skills to a Successful CareerProfessional Skills to a Successful Career
Professional Skills to a Successful Career
 
Introduction to Professional Development 231112
Introduction to Professional Development 231112Introduction to Professional Development 231112
Introduction to Professional Development 231112
 
From Real to Ideal: Envisioning and Moving Toward Your Best Culture [Culture ...
From Real to Ideal: Envisioning and Moving Toward Your Best Culture [Culture ...From Real to Ideal: Envisioning and Moving Toward Your Best Culture [Culture ...
From Real to Ideal: Envisioning and Moving Toward Your Best Culture [Culture ...
 
Johns Hopkins Innovation Factory - Entrepreneur Development Program #1
Johns Hopkins Innovation Factory - Entrepreneur Development Program #1Johns Hopkins Innovation Factory - Entrepreneur Development Program #1
Johns Hopkins Innovation Factory - Entrepreneur Development Program #1
 
Johns hopkins innovation factory entrepreneur development program #5
Johns hopkins innovation factory entrepreneur development program #5Johns hopkins innovation factory entrepreneur development program #5
Johns hopkins innovation factory entrepreneur development program #5
 
Breaking the Code of Interview Implicit Bias to Value Different Gender Compet...
Breaking the Code of Interview Implicit Bias to Value Different Gender Compet...Breaking the Code of Interview Implicit Bias to Value Different Gender Compet...
Breaking the Code of Interview Implicit Bias to Value Different Gender Compet...
 
Johns Hopkins Innovation Factory - Entrepreneur Development Program #2
Johns Hopkins Innovation Factory - Entrepreneur Development Program #2Johns Hopkins Innovation Factory - Entrepreneur Development Program #2
Johns Hopkins Innovation Factory - Entrepreneur Development Program #2
 
Johns hopkins innovation factory entrepreneur development program #3
Johns hopkins innovation factory   entrepreneur development program #3Johns hopkins innovation factory   entrepreneur development program #3
Johns hopkins innovation factory entrepreneur development program #3
 
Remarkable: Proven Insights to Accelerate Your Career
Remarkable: Proven Insights to Accelerate Your CareerRemarkable: Proven Insights to Accelerate Your Career
Remarkable: Proven Insights to Accelerate Your Career
 
Soft skills series Problem Solving and Listening Skills
Soft skills series   Problem Solving and Listening SkillsSoft skills series   Problem Solving and Listening Skills
Soft skills series Problem Solving and Listening Skills
 
Short Guide to Productivity
Short Guide to ProductivityShort Guide to Productivity
Short Guide to Productivity
 
Documentation Leadership: Dealing with People Issues in Technical Documentation
Documentation Leadership: Dealing with People Issues in Technical DocumentationDocumentation Leadership: Dealing with People Issues in Technical Documentation
Documentation Leadership: Dealing with People Issues in Technical Documentation
 
Coaching For Optimal Performance
Coaching For Optimal Performance   Coaching For Optimal Performance
Coaching For Optimal Performance
 
Developing Strong Leaders in a Risk Averse Environment
Developing Strong Leaders in a Risk Averse EnvironmentDeveloping Strong Leaders in a Risk Averse Environment
Developing Strong Leaders in a Risk Averse Environment
 
25-TC - Presentation Skills deck v2 10.29.2015
25-TC - Presentation Skills deck v2 10.29.201525-TC - Presentation Skills deck v2 10.29.2015
25-TC - Presentation Skills deck v2 10.29.2015
 
Creative Thinking Skills
Creative Thinking SkillsCreative Thinking Skills
Creative Thinking Skills
 
Agile soft skills suitecase - iad 2011
Agile soft skills suitecase - iad 2011Agile soft skills suitecase - iad 2011
Agile soft skills suitecase - iad 2011
 
Slides cbi
Slides cbiSlides cbi
Slides cbi
 
What are Graduate Schemes and How do I Apply?
What are Graduate Schemes and How do I Apply?What are Graduate Schemes and How do I Apply?
What are Graduate Schemes and How do I Apply?
 
Coaching conversations
Coaching conversationsCoaching conversations
Coaching conversations
 

Similar a 14 Habits of Highly Effective Technical Writers

Product design engineer communication skills pdf
Product design engineer communication skills pdfProduct design engineer communication skills pdf
Product design engineer communication skills pdfjess89058
 
Unforgettable Content Strategy Portfolios
Unforgettable Content Strategy Portfolios Unforgettable Content Strategy Portfolios
Unforgettable Content Strategy Portfolios Masa Zokaei Edie
 
Engineering manager communication skills pdf
Engineering manager communication skills pdfEngineering manager communication skills pdf
Engineering manager communication skills pdfdavidroy947
 
Employee development specialist communication skills pdf
Employee development specialist communication skills pdfEmployee development specialist communication skills pdf
Employee development specialist communication skills pdfdavidroy947
 
Engineering Career Paths.pdf
Engineering Career Paths.pdfEngineering Career Paths.pdf
Engineering Career Paths.pdfVladimirRadzivil
 
Storage engineer communication skills pdf
Storage engineer communication skills pdfStorage engineer communication skills pdf
Storage engineer communication skills pdfzakphillips593
 
Improve leadership communication pdf free download
Improve leadership communication pdf free downloadImprove leadership communication pdf free download
Improve leadership communication pdf free downloadjennymarion69
 
Breaking Into Product and Tech by Microsoft Product Leader
Breaking Into Product and Tech by Microsoft Product LeaderBreaking Into Product and Tech by Microsoft Product Leader
Breaking Into Product and Tech by Microsoft Product LeaderProduct School
 
Project Manager Interview Questions
Project Manager Interview QuestionsProject Manager Interview Questions
Project Manager Interview Questionsshasunder
 
Architecture communication skills pdf
Architecture communication skills pdfArchitecture communication skills pdf
Architecture communication skills pdfbethanygray705
 
Facebook's Official Guide to Technical Program Management Candidates
Facebook's Official Guide to Technical Program Management CandidatesFacebook's Official Guide to Technical Program Management Candidates
Facebook's Official Guide to Technical Program Management CandidatesLewis Lin 🦊
 
Production manager communication skills pdf
Production manager communication skills pdfProduction manager communication skills pdf
Production manager communication skills pdfsandersjamie999
 
Procurement engineer communication skills pdf
Procurement engineer communication skills pdfProcurement engineer communication skills pdf
Procurement engineer communication skills pdfjess89058
 
Equipment engineer communication skills pdf
Equipment engineer communication skills pdfEquipment engineer communication skills pdf
Equipment engineer communication skills pdfdavidroy947
 
Business director communication skills pdf
Business director communication skills pdfBusiness director communication skills pdf
Business director communication skills pdfpercyweasley32
 
Business unit manager communication skills pdf
Business unit manager communication skills pdfBusiness unit manager communication skills pdf
Business unit manager communication skills pdfpercyweasley32
 
Production worker communication skills pdf
Production worker communication skills pdfProduction worker communication skills pdf
Production worker communication skills pdfsandersjamie999
 
Data entry operator communication skills pdf
Data entry operator communication skills pdfData entry operator communication skills pdf
Data entry operator communication skills pdfjulielombard79
 
Improve communication problems pdf free download
Improve communication problems pdf free downloadImprove communication problems pdf free download
Improve communication problems pdf free downloadjennymarion69
 
How to build a content marketing and social media engine
How to build a content marketing and social media engineHow to build a content marketing and social media engine
How to build a content marketing and social media engineMarcel Santilli
 

Similar a 14 Habits of Highly Effective Technical Writers (20)

Product design engineer communication skills pdf
Product design engineer communication skills pdfProduct design engineer communication skills pdf
Product design engineer communication skills pdf
 
Unforgettable Content Strategy Portfolios
Unforgettable Content Strategy Portfolios Unforgettable Content Strategy Portfolios
Unforgettable Content Strategy Portfolios
 
Engineering manager communication skills pdf
Engineering manager communication skills pdfEngineering manager communication skills pdf
Engineering manager communication skills pdf
 
Employee development specialist communication skills pdf
Employee development specialist communication skills pdfEmployee development specialist communication skills pdf
Employee development specialist communication skills pdf
 
Engineering Career Paths.pdf
Engineering Career Paths.pdfEngineering Career Paths.pdf
Engineering Career Paths.pdf
 
Storage engineer communication skills pdf
Storage engineer communication skills pdfStorage engineer communication skills pdf
Storage engineer communication skills pdf
 
Improve leadership communication pdf free download
Improve leadership communication pdf free downloadImprove leadership communication pdf free download
Improve leadership communication pdf free download
 
Breaking Into Product and Tech by Microsoft Product Leader
Breaking Into Product and Tech by Microsoft Product LeaderBreaking Into Product and Tech by Microsoft Product Leader
Breaking Into Product and Tech by Microsoft Product Leader
 
Project Manager Interview Questions
Project Manager Interview QuestionsProject Manager Interview Questions
Project Manager Interview Questions
 
Architecture communication skills pdf
Architecture communication skills pdfArchitecture communication skills pdf
Architecture communication skills pdf
 
Facebook's Official Guide to Technical Program Management Candidates
Facebook's Official Guide to Technical Program Management CandidatesFacebook's Official Guide to Technical Program Management Candidates
Facebook's Official Guide to Technical Program Management Candidates
 
Production manager communication skills pdf
Production manager communication skills pdfProduction manager communication skills pdf
Production manager communication skills pdf
 
Procurement engineer communication skills pdf
Procurement engineer communication skills pdfProcurement engineer communication skills pdf
Procurement engineer communication skills pdf
 
Equipment engineer communication skills pdf
Equipment engineer communication skills pdfEquipment engineer communication skills pdf
Equipment engineer communication skills pdf
 
Business director communication skills pdf
Business director communication skills pdfBusiness director communication skills pdf
Business director communication skills pdf
 
Business unit manager communication skills pdf
Business unit manager communication skills pdfBusiness unit manager communication skills pdf
Business unit manager communication skills pdf
 
Production worker communication skills pdf
Production worker communication skills pdfProduction worker communication skills pdf
Production worker communication skills pdf
 
Data entry operator communication skills pdf
Data entry operator communication skills pdfData entry operator communication skills pdf
Data entry operator communication skills pdf
 
Improve communication problems pdf free download
Improve communication problems pdf free downloadImprove communication problems pdf free download
Improve communication problems pdf free download
 
How to build a content marketing and social media engine
How to build a content marketing and social media engineHow to build a content marketing and social media engine
How to build a content marketing and social media engine
 

Más de Saiff Solutions, Inc.

Outsourcing Multimedia Content Development
Outsourcing Multimedia Content DevelopmentOutsourcing Multimedia Content Development
Outsourcing Multimedia Content DevelopmentSaiff Solutions, Inc.
 
The Future is Now: Neuroscience, Chatbots, Voice, and Microcontent
The Future is Now: Neuroscience, Chatbots, Voice, and MicrocontentThe Future is Now: Neuroscience, Chatbots, Voice, and Microcontent
The Future is Now: Neuroscience, Chatbots, Voice, and MicrocontentSaiff Solutions, Inc.
 
Learning Together: Motion Infographics
Learning Together: Motion InfographicsLearning Together: Motion Infographics
Learning Together: Motion InfographicsSaiff Solutions, Inc.
 
Tracking and Controlling Technical Documentation Projects
Tracking and Controlling Technical Documentation ProjectsTracking and Controlling Technical Documentation Projects
Tracking and Controlling Technical Documentation ProjectsSaiff Solutions, Inc.
 
Managing a Global Team: Resolving Cross-Cultural Issues
Managing a Global Team: Resolving Cross-Cultural IssuesManaging a Global Team: Resolving Cross-Cultural Issues
Managing a Global Team: Resolving Cross-Cultural IssuesSaiff Solutions, Inc.
 
From Good to Great Products: When Engineers Work with Technical Writers
From Good to Great Products: When Engineers Work with Technical WritersFrom Good to Great Products: When Engineers Work with Technical Writers
From Good to Great Products: When Engineers Work with Technical WritersSaiff Solutions, Inc.
 
From Good to Great Products - When Engineers Work with Technical Writers - Ja...
From Good to Great Products - When Engineers Work with Technical Writers - Ja...From Good to Great Products - When Engineers Work with Technical Writers - Ja...
From Good to Great Products - When Engineers Work with Technical Writers - Ja...Saiff Solutions, Inc.
 
Saiff Solutions | Technical Writing, Software Documentation, Outsourcing
Saiff Solutions | Technical Writing, Software Documentation, OutsourcingSaiff Solutions | Technical Writing, Software Documentation, Outsourcing
Saiff Solutions | Technical Writing, Software Documentation, OutsourcingSaiff Solutions, Inc.
 
LavaCon-Sponsored: Are You Ready to Go to Tech Comm Heaven?
LavaCon-Sponsored: Are You Ready to Go to Tech Comm Heaven?LavaCon-Sponsored: Are You Ready to Go to Tech Comm Heaven?
LavaCon-Sponsored: Are You Ready to Go to Tech Comm Heaven?Saiff Solutions, Inc.
 
Managing Technical Writing Outsourcing in an Agile Environment
Managing Technical Writing Outsourcing in an Agile EnvironmentManaging Technical Writing Outsourcing in an Agile Environment
Managing Technical Writing Outsourcing in an Agile EnvironmentSaiff Solutions, Inc.
 
Technical Writing Outsourcing in an Agile Environment
Technical Writing Outsourcing in an Agile EnvironmentTechnical Writing Outsourcing in an Agile Environment
Technical Writing Outsourcing in an Agile EnvironmentSaiff Solutions, Inc.
 
How to Motivate and Empower Globally-Competitive Teams of Content Professionals
How to Motivate and Empower Globally-Competitive Teams of Content ProfessionalsHow to Motivate and Empower Globally-Competitive Teams of Content Professionals
How to Motivate and Empower Globally-Competitive Teams of Content ProfessionalsSaiff Solutions, Inc.
 
The Globalization of Technical Writing - Threat or Opportunity
The Globalization of Technical Writing - Threat or OpportunityThe Globalization of Technical Writing - Threat or Opportunity
The Globalization of Technical Writing - Threat or OpportunitySaiff Solutions, Inc.
 

Más de Saiff Solutions, Inc. (13)

Outsourcing Multimedia Content Development
Outsourcing Multimedia Content DevelopmentOutsourcing Multimedia Content Development
Outsourcing Multimedia Content Development
 
The Future is Now: Neuroscience, Chatbots, Voice, and Microcontent
The Future is Now: Neuroscience, Chatbots, Voice, and MicrocontentThe Future is Now: Neuroscience, Chatbots, Voice, and Microcontent
The Future is Now: Neuroscience, Chatbots, Voice, and Microcontent
 
Learning Together: Motion Infographics
Learning Together: Motion InfographicsLearning Together: Motion Infographics
Learning Together: Motion Infographics
 
Tracking and Controlling Technical Documentation Projects
Tracking and Controlling Technical Documentation ProjectsTracking and Controlling Technical Documentation Projects
Tracking and Controlling Technical Documentation Projects
 
Managing a Global Team: Resolving Cross-Cultural Issues
Managing a Global Team: Resolving Cross-Cultural IssuesManaging a Global Team: Resolving Cross-Cultural Issues
Managing a Global Team: Resolving Cross-Cultural Issues
 
From Good to Great Products: When Engineers Work with Technical Writers
From Good to Great Products: When Engineers Work with Technical WritersFrom Good to Great Products: When Engineers Work with Technical Writers
From Good to Great Products: When Engineers Work with Technical Writers
 
From Good to Great Products - When Engineers Work with Technical Writers - Ja...
From Good to Great Products - When Engineers Work with Technical Writers - Ja...From Good to Great Products - When Engineers Work with Technical Writers - Ja...
From Good to Great Products - When Engineers Work with Technical Writers - Ja...
 
Saiff Solutions | Technical Writing, Software Documentation, Outsourcing
Saiff Solutions | Technical Writing, Software Documentation, OutsourcingSaiff Solutions | Technical Writing, Software Documentation, Outsourcing
Saiff Solutions | Technical Writing, Software Documentation, Outsourcing
 
LavaCon-Sponsored: Are You Ready to Go to Tech Comm Heaven?
LavaCon-Sponsored: Are You Ready to Go to Tech Comm Heaven?LavaCon-Sponsored: Are You Ready to Go to Tech Comm Heaven?
LavaCon-Sponsored: Are You Ready to Go to Tech Comm Heaven?
 
Managing Technical Writing Outsourcing in an Agile Environment
Managing Technical Writing Outsourcing in an Agile EnvironmentManaging Technical Writing Outsourcing in an Agile Environment
Managing Technical Writing Outsourcing in an Agile Environment
 
Technical Writing Outsourcing in an Agile Environment
Technical Writing Outsourcing in an Agile EnvironmentTechnical Writing Outsourcing in an Agile Environment
Technical Writing Outsourcing in an Agile Environment
 
How to Motivate and Empower Globally-Competitive Teams of Content Professionals
How to Motivate and Empower Globally-Competitive Teams of Content ProfessionalsHow to Motivate and Empower Globally-Competitive Teams of Content Professionals
How to Motivate and Empower Globally-Competitive Teams of Content Professionals
 
The Globalization of Technical Writing - Threat or Opportunity
The Globalization of Technical Writing - Threat or OpportunityThe Globalization of Technical Writing - Threat or Opportunity
The Globalization of Technical Writing - Threat or Opportunity
 

Último

Scaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organizationScaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organizationRadu Cotescu
 
Powerful Google developer tools for immediate impact! (2023-24 C)
Powerful Google developer tools for immediate impact! (2023-24 C)Powerful Google developer tools for immediate impact! (2023-24 C)
Powerful Google developer tools for immediate impact! (2023-24 C)wesley chun
 
A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)Gabriella Davis
 
Data Cloud, More than a CDP by Matt Robison
Data Cloud, More than a CDP by Matt RobisonData Cloud, More than a CDP by Matt Robison
Data Cloud, More than a CDP by Matt RobisonAnna Loughnan Colquhoun
 
A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?Igalia
 
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, AdobeApidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobeapidays
 
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
 
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptxHampshireHUG
 
GenCyber Cyber Security Day Presentation
GenCyber Cyber Security Day PresentationGenCyber Cyber Security Day Presentation
GenCyber Cyber Security Day PresentationMichael W. Hawkins
 
AWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of TerraformAWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of TerraformAndrey Devyatkin
 
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
 
Bajaj Allianz Life Insurance Company - Insurer Innovation Award 2024
Bajaj Allianz Life Insurance Company - Insurer Innovation Award 2024Bajaj Allianz Life Insurance Company - Insurer Innovation Award 2024
Bajaj Allianz Life Insurance Company - Insurer Innovation Award 2024The Digital Insurer
 
Exploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone ProcessorsExploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone Processorsdebabhi2
 
Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...apidays
 
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemkeProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemkeProduct Anonymous
 
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
 
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...
Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...Neo4j
 
HTML Injection Attacks: Impact and Mitigation Strategies
HTML Injection Attacks: Impact and Mitigation StrategiesHTML Injection Attacks: Impact and Mitigation Strategies
HTML Injection Attacks: Impact and Mitigation StrategiesBoston Institute of Analytics
 
Strategize a Smooth Tenant-to-tenant Migration and Copilot Takeoff
Strategize a Smooth Tenant-to-tenant Migration and Copilot TakeoffStrategize a Smooth Tenant-to-tenant Migration and Copilot Takeoff
Strategize a Smooth Tenant-to-tenant Migration and Copilot Takeoffsammart93
 

Último (20)

Scaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organizationScaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organization
 
Powerful Google developer tools for immediate impact! (2023-24 C)
Powerful Google developer tools for immediate impact! (2023-24 C)Powerful Google developer tools for immediate impact! (2023-24 C)
Powerful Google developer tools for immediate impact! (2023-24 C)
 
A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)
 
Data Cloud, More than a CDP by Matt Robison
Data Cloud, More than a CDP by Matt RobisonData Cloud, More than a CDP by Matt Robison
Data Cloud, More than a CDP by Matt Robison
 
A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?
 
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, AdobeApidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
 
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
 
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
 
GenCyber Cyber Security Day Presentation
GenCyber Cyber Security Day PresentationGenCyber Cyber Security Day Presentation
GenCyber Cyber Security Day Presentation
 
AWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of TerraformAWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of Terraform
 
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...
 
Bajaj Allianz Life Insurance Company - Insurer Innovation Award 2024
Bajaj Allianz Life Insurance Company - Insurer Innovation Award 2024Bajaj Allianz Life Insurance Company - Insurer Innovation Award 2024
Bajaj Allianz Life Insurance Company - Insurer Innovation Award 2024
 
Exploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone ProcessorsExploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone Processors
 
Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...
 
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemkeProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
 
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
 
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
 
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...
Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...
 
HTML Injection Attacks: Impact and Mitigation Strategies
HTML Injection Attacks: Impact and Mitigation StrategiesHTML Injection Attacks: Impact and Mitigation Strategies
HTML Injection Attacks: Impact and Mitigation Strategies
 
Strategize a Smooth Tenant-to-tenant Migration and Copilot Takeoff
Strategize a Smooth Tenant-to-tenant Migration and Copilot TakeoffStrategize a Smooth Tenant-to-tenant Migration and Copilot Takeoff
Strategize a Smooth Tenant-to-tenant Migration and Copilot Takeoff
 

14 Habits of Highly Effective Technical Writers

  • 1.
  • 2. • Technical communications leader • 32 years of technical documentation experience • Led writing teams at 6 US companies • Founded Saiff Solutions, Inc. in 2011 • Provides content development to Fortune 500 companies in Japan & US • Loves acronyms About the Speaker: Barry Saiff
  • 4. Vision DON’T TAKE IT PERSONALLY a . (learn) 7 Habits of Highly Effective Technical Writers 1 LEARN BEFORE ASKING (respect, impress) 2 ASK . (often) 3 REWRITE (always) 4 ACQUIRE FEEDBACK (test, reviews) 5 UNDERSTAND (before publishing) 6 CONTRIBUTE7
  • 5. Vision 1. DON’T TAKE IT PERSONALLY (learn) Great technical writers thrive on criticism. They understand that it enables them to improve, and to improve the accuracy and readability of their content. So, don’t take criticism personally. Use it to your advantage.
  • 6. Vision Learn as much as you can from available resources before asking questions. In this way, you can respect others’ time and impress your colleagues with your ability to ask intelligent questions. 2. LEARN BEFORE ASKING (respect, impress)
  • 7. Vision Technical writing requires good people skills. Don’t attempt it alone. Ask questions. Ask for help. 3. ASK (often)
  • 8. Vision Pick 3 of your favorite writers. If you were able to see their first drafts, you’d probably think, “I can do much better.” The best writers in the world are the best re-writers. Always rewrite, rewrite, and rewrite some more. 4. REWRITE (always)
  • 9. Vision Technical writing is almost never 100% on the first draft. Without adequate testing and review, accuracy is often unattainable. Make sure you get the feedback you need to excel. 5. ACQUIRE FEEDBACK (test, reviews)
  • 10. Vision When you start, you may not fully understand your subject matter. That’s fine. By the time you publish, make sure you do understand. If you don’t understand what you write, your readers are not likely to understand it, either. If you write something, you need to understand what you wrote. Even if it is just a draft to show your editor, you need to either a) fully understand what you wrote, or b) have a list of questions. Do not write a sentence that you yourself do not understand. 6. UNDERSTAND (before publishing)
  • 11. Vision Notice things. Does the prototype work as expected? Are the user interface labels capitalized consistently? Ask questions. Make suggestions. Be a part of the product team. 7. CONTRIBUTE
  • 12. Vision BE A CUSTOMER ADVOCATE 7 Habits of Highly Effective Technical Communications Leaders 8 ADVOCATE FOR PROCESS IMPROVEMENTS9 CARE ABOUT ALL CUSTOMER-VISIBLE CONTENT 10 BE AN EFFECTIVE INTRAPRENEUR11 KNOW YOUR AUDIENCE12 PROMOTE APPROPRIATE TECHNICAL COMMUNICATIONS METHODOLOGIES, GENTLY 13 KEEP PERSPECTIVE, AND DE-STRESS 14
  • 13. Vision 7 Habits of Highly Effective Technical Communications Leaders You can be an effective leader, regardless of your position. These 7 habits go beyond the basics of developing good content, to answer this question: As a technical communications leader, at any level, how do you influence the work environment, improve the processes, and educate the people to make continuous improvement possible?
  • 14. Vision While you may have less product knowledge than an engineer, you can view the product from a user’s perspective. Share your input and advocate for product and process improvements. Support similar efforts initiated by others. Focus on quality. 8. BE A CUSTOMER ADVOCATE
  • 15. Vision Process improvements can benefit everyone on the team, and improve product quality. Can the quality assurance team test the documentation? Can technical writers edit the user interface text and error messages? Can written documentation reviews become a factor in the performance evaluations of all product team members? Would documentation review meetings improve quality? 9. ADVOCATE FOR PROCESS IMPROVEMENTS
  • 16. Vision If you’re only writing the customer documentation, there is a chance that no one with your skills is editing other user-visible content. Even if you cannot edit this content, you can educate others about key technical writing practices. For example – One concept, One term – each word should be used to mean only one thing. This avoids user confusion, and saves translation funds. Another key technical writing practice: short sentences. 10. CARE ABOUT ALL CUSTOMER-VISIBLE CONTENT
  • 17. Vision Think about how to create change – look before you leap. Understand the who, what, and how of change. Who are the key stakeholders and decision-makers, and what motivates them? What do they care about? How can you best bring them on board? What are their backgrounds – cultural, professional, educational? Start with curiosity. Listen. Discuss. Ask questions. 11. BE AN EFFECTIVE INTRAPRENEUR
  • 18. What do you know about the users – education levels, roles? How do they use the product and access the documentation? What percentage read the documentation in English? Collaborative efforts with other teams can aid your research. One way to learn more is to conduct a user survey. While gaining approval can be an uphill battle, the insights gained from a well-designed survey can make the effort worthwhile. Vision12. KNOW YOU AUDIENCE
  • 19. Vision Not every organization needs to use the latest methodologies. What worked elsewhere may not work for your team. Bring others along with you – educate and involve engineers, quality assurance personnel, marketers, and product managers in assessing and exploring new methodologies. For example, some organizations can benefit from adopting topic- based authoring, without XML or DITA. 13. PROMOTE APPROPRIATE TECHNICAL COMMUNICATIONS METHODOLOGIES, GENTLY
  • 20. Vision Mistakes provide tremendous opportunities for personal and organizational growth, including improved processes, communications, and skills. Accept these moments and make the most of them. Learn from successes and failures. Remember that what is truly irreplaceable is human life. Learn what you need, and what your coworkers need, to reduce and relieve stress. 14. KEEP PERSPECTIVE, AND DE-STRESS
  • 21. Vision 7 Habits of Highly Effective Technical Communications Leaders Consistently practicing these 7 habits will support your development as an effective technical communications leader, continuous process improvement in your organization, harmonious work relationships, and improved content and product quality. Be the change you wish to see.
  • 22. BONUS: Resources • BALANCE infographic (Respect) – We will send it, with the presentation, to all webinar registrants. • Global Content Creation – Making it Work • A Motivating SLAP • The 21 Dimensions of Respect for Foreigners • 2016 New Years Free Gifts • What do good technical writers do? Why do we need them?
  • 23. Email: barrysaiff@saiffsolutions.com Skype: SaiffSolutions Contact: +1 415 350 2959 +63 917 872 0929 Web: www.saiffsolutions.com Join us at: LavaCon Las Vegas, October 26-29: http://lavacon.org/2016/vegas/ ALL QUESTIONS ARE WELCOME!
  • 24. BONUS: Creativity in the Face of Stress A good manager creates and protects a healthy culture. Culture lives in the details. In every moment, every action and interaction. Think about how you deal with stress. You are a role model for your team. Successful managers rely on the 3 Cs: Caring, Competence, and Creativity