technical writers thriving in 2020 · •content developer •documentation manager •information...
TRANSCRIPT
![Page 1: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/1.jpg)
Technical Writers
Thriving in 2020
Eli Jacobs
May, 2015
![Page 2: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/2.jpg)
What Should We Call Ourselves?
• Technical Writer
• Technical Communicator
• Technical Author
• Information Developer
• Information Engineer
• Documentation Specialist
• Content Developer
• Documentation Manager
• Information Designer
TWs Thriving in 2020 2
• Information Architect
• Technical Information Developer
• Trainer & Communications Consultant
• Senior Content Developer
• Senior Content Project Manager
• Senior Documentation Manager
• Senior Documentation Specialist
• Senior Experience Developer
• Senior Information Developer
• Senior Instructional Designer
![Page 3: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/3.jpg)
What Should We Call Ourselves?
• Technical Writer
• Technical Communicator
• Technical Author
• Information Developer
• Information Engineer
• Documentation Specialist
• Content Developer
• Documentation Manager
• Information Designer
TWs Thriving in 2020 3
• Information Architect
• Technical Information Developer
• Trainer &Communications Consultant
• Senior Content Developer
• Senior Content Project Manager
• Senior Documentation Manager
• Senior Documentation Specialist
• Senior Experience Developer
• Senior Information Developer
• Senior Instructional Designer
hmmm…
…is it really about
job titles?
![Page 4: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/4.jpg)
What Do TWs Really Want?
• To clarify – to ourselves and others -what we do
• To improve the perception of our field
• To know the direction in which we should develop our careers
TWs Thriving in 2020 4
TECH WRITERS
![Page 5: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/5.jpg)
How to Approach This? How’s the Market?
• Looking at the hi-tech market can provide strategic insight into the field of tech writing
• There are more than 2,000 technical writers in Israel today - why?
• This is the result of certain market realities
• When the market shakes, tech writers shake
TWs Thriving in 2020 5
![Page 6: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/6.jpg)
2015: Possible Company Structure for a Mid-Sized Tech Company
TWs Thriving in 2020 6
• R&D – 150
• QA – 15
• Product Management - 6
• Marketing – 12
• Technical Writers - 5
• Support – 30
• Sales & Account Management - 12
![Page 7: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/7.jpg)
Deployment
Sales & Marketing
RequirementsDesign &
Architecture
Implementation Testing
![Page 8: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/8.jpg)
2020: Possible Company Structure for a Mid-Sized Tech Company
TWs Thriving in 2020 8
• R&D – 150
• Of them 6 = DC
• QA – 15
• Of them 2 = DC
• Product Management – 6
• Of them 6 = DC
• Marketing – 12
• Technical Writers – 0
• Documentation Manager - 1
• Support – 30
• Of them 4 = DC
• Sales & Account Management – 12
• Of them 4 = DC
DC = Documentation Certified
![Page 9: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/9.jpg)
Bubble-Crash-Correction
• Speculative – generate revenue in distant future
• Fat
• Under-needed
• Over-funded
• Over-resourced
• Over-staffed
• Little accountability
TWs Thriving in 2020 9
![Page 10: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/10.jpg)
Bubble-Crash-Correction
• Emergency measures
• TWs and Marketing people are sent home
• Struggle to “correct”
TWs Thriving in 2020 10
![Page 11: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/11.jpg)
TWs Thriving in 2020 11
Market in correction
![Page 12: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/12.jpg)
Finding the Balance
TWs Thriving in 2020 12
• Smaller investments
• Much more accountability
• Resource optimization
• Balance between conservative-today-focused vs. visionary-future-focused
• Companies work on products for the future but also generate revenue today
![Page 13: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/13.jpg)
Finding the Balance – in Hiring
TWs Thriving in 2020 13
• Looking for the best people
• Very serious, thorough hiring process
• Demanding excellence
• Example: a medium-sized VoIP company looking for a Product Manager may hire someone who ran and sold a successful VoIP start-up
• Senior staff– more hands-on, more details oriented
• Cross-disciplinary
![Page 14: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/14.jpg)
Who Is Valuable in a Hi-Tech Company?
• A great VP of R&D understands the implications of her decisions on the rest of the organization: Marketing, Sales, HR, etc.
• A great VP of Marketing can brainstorm a market strategy and analyze the demands on R&D, Finance, etc.
• Valuable team members:• Understand many things
• Do one thing superbly
• Sometimes do more than one thing
• We can too
TWs Thriving in 2020 14
![Page 15: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/15.jpg)
Multi-Disciplinary (1)
• A great VP of R&D understands the implications of her decisions on the rest of the organization: Marketing, Sales, HR, etc.
• A great VP of Marketing can brainstorm a market strategy and analyze the demands on R&D, Finance, etc.
TWs Thriving in 2020 15
![Page 16: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/16.jpg)
Multi-Disciplinary (2)
• Valuable team members:• Understand many things
• Do one thing superbly
• Sometimes do more than one thing
(1) “My job is X; don’t bother me with anything else.”
(2) “My job is A and B and C and X and Y and Z; and I do X superbly and take ultimate responsibility for X.
• How would you rank TWs on the multi-disciplinary scale? Are most TWs more like (1) or more like (2)?
TWs Thriving in 2020 16
![Page 17: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/17.jpg)
TWs Thriving in 2020 17
How can we turn a TW into an F-15 Pilot?
![Page 18: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/18.jpg)
What Else Can a TW Do?
Ideally, you should be no more than 1 step away from the “critical path”
Do you ever need to stay late?
TWs Thriving in 2020 18
Skill/Interest Area Deliverable
Visual, sensitivity to usability
GUI Wire Frames, FRS, MRD
Social skills Marketing, Support, More Interact with customers and partners
Born teacher Training Training Materials; training
Product Market Awareness Product MRD, FRS, Much More
System Expert Customer Support; Design, More
Customer Support; CS Tool, etc.
Programming Knowledge Development, Application Engineering
APIs, SDKs, Component Design, Naming Conventions
Analytical Thinking Architecture, QA, etc Sky’s the limit
Domain Expertise Marketing Any Marketing Material; Develop Strategy
Documentation Expert DOCUMENTATION Manage resources, tools, schedules, etc.
![Page 19: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/19.jpg)
How?
• Understand many things
• Do one thing superbly
• Do more than one thing
• Maybe you already are
• Expand your involvement even more
• Figure out what you are good at
TWs Thriving in 2020 19
• Keep your ears open – where are resources missing?
• Do it with finesse
• Overlapping with your assignments
• Not at the expense of your day job
![Page 20: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/20.jpg)
Case Study: Rachel
• Rachel wrote a 200-page Admin Guide for an existing system that had no documentation; she had to do lots of experimenting
• With each draft she also submitted details of UI and system bugs
• The client called me once a week to praise Rachel work
• The client called me 2 months later and asked if Rachel was available to do QA work for them
TWs Thriving in 2020 20
![Page 21: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/21.jpg)
Case Study: Robbie• Robbie was writing a 2nd tier support guide for a large company
• SMEs - R&D team in Israel
• Audience – Support team in Europe
• The division of responsibility was not clear• For example, “How often should this batch job be run?” • R&D said, “This is a decision for the Support Team”• The Support Team said, “We don’t understand the implications – should this be once
every ten minutes? Once a day? Once a month?
• Robbie helped “negotiate” this issue
• Now both R&D and the Support team consult with Robbie on similar issues
• What should Robbie’s job title be?
TWs Thriving in 2020 21
![Page 22: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/22.jpg)
Case Study: Rivka
• Rivka is very pedantic
• We were called into a medical device company
• On the phone they said that they needed a TW to work on change control reports required by the FDA
• Rivka started work and they were impressed with her thoroughness
• Rivka’s role was then expanded – she is now responsible for tracking the change control process for a team of 12 Change Engineers
• What should Rivka’s job title be? Is she still a technical writer?
TWs Thriving in 2020 22
![Page 23: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/23.jpg)
TWs Thriving in 2020 23
So What Should We Be Called?
![Page 24: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/24.jpg)
At work:
Avi, Phil, David, Julie, Zecharia, Esther, Danielle, Doron, Leybl, David,
Itzchak, Mike, Daniela, Yaakov, Avi, Sarah, Michal, Rami, Daniel, Meir,
Yitzchak, Yitzchak, Jonathan, Baruch, Ari, Debbie, David, Monica, Ester,
Shifra, David, Yossi, Rachel, James, Rochelle, Jo, Yechiel, Leah, Laura,
Yehoshua, Amnon, Rivka, Ben, J, Dganit, Devorah, Eliezer, Menachem,
Nadina, Naomi, Shlomo, Nathan, Dorit, Asher, Marina, Adina, Uri, Steven,
Yehuda, Yaakov, Esther-Rena, Sara, Caroline, Maya, Annet, Lisa, Sara, Etay,
Ben, Janet, Yaacov, Julian, Judy, Steve, Yisrael, Hilla, Yehuda
TWs Thriving in 2020 24
![Page 25: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/25.jpg)
…and outside of work:
• When speaking to people outside the tech industry:• Say, “I work in hi-tech”
• For people who work in hi-tech• Say, “I work at [Company Name] on the [Product Team] [in QA] [in R&D] [in
Customer Support]”
TWs Thriving in 2020 25
![Page 26: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/26.jpg)
Summary
• Market realities seem to indicate• Companies are careful to maximize their resources
• It appears that• Although the entire product/project lifecycle involves documentation,
technical writers are primarily used for end-user documents
• Tech writers are smart and have great opportunities to learn and expand their knowledge and skills
• Thoughts• Tech writers can and should find ways to, organically, contribute to their
organizations, beyond their narrowly defined job description
TWs Thriving in 2020 26
![Page 27: Technical Writers Thriving in 2020 · •Content Developer •Documentation Manager •Information Designer TWs Thriving in 2020 2 ... Product Manager may hire someone who ran and](https://reader034.vdocuments.net/reader034/viewer/2022042405/5f1cdf8edb69196b542aaf2a/html5/thumbnails/27.jpg)
Conclusion
• By expanding your contribution beyond your strictly defined job title:
• Make yourself more valuable and
• Advance yourself and secure your job
• Help your company
• Strengthen the entire Tech Writing community
• Enhance the entire Israeli hi tech market
• Humanity? We’ll leave that to the IEEE
TWs Thriving in 2020 27