Technical Writer’s Workflow
In a technical writer's workflow, creating effective documentation is key. From gathering information to doing your own research, this process involves various steps such as saying the most using the least amount of language, identifying main points of contact, and ensuring technical accuracy. It also focuses on what technical documentation should be and should not be, emphasizing clarity, conciseness, relevance, and avoiding complexity, emotional language, and anthropomorphism. Reviewing drafts through SME, QA, and peer reviews is crucial to producing high-quality technical content.
Uploaded on Feb 26, 2025 | 0 Views
Download Presentation
Please find below an Image/Link to download the presentation.
The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author.If you encounter any issues during the download, it is possible that the publisher has removed the file from their server.
You are allowed to download the files provided on this website for personal or commercial use, subject to the condition that they are used lawfully. All files are the property of their respective owners.
The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author.
E N D
Presentation Transcript
CONFIDENTIAL designator Technical Writer s Workflow 1.0 Levi Valeeva Technical Writer 2 1 V0000000
Technical Writers Workflow CONFIDENTIAL designator Creating your first draft Saying the most using the least amount of language Gathering information Doing your own research 2 V0000000
Technical Writers Workflow CONFIDENTIAL designator Gathering information Your main points of contact: Project Manager Content Strategist Subject Matter Experts (SMEs) Quality Assurance (QA) 3 V0000000
Technical Writers Workflow CONFIDENTIAL designator Doing your own research Digging deeper: Audience analysis Support team Marketing team Analytics 4 V0000000
Technical Writers Workflow CONFIDENTIAL designator Saying the most using the least amount of language Things to consider: What technical documentation should be? What technical documentation should not be? 5 V0000000
Technical Writers Workflow CONFIDENTIAL designator What technical documentation should be? Correct The most beautifully-written documentation is useless if it is not technically correct. Clear Even if your documentation is technically correct, users will avoid it if it is not written clearly. Concise Users have only so much time to go through your documentation. Make it count. Relevant Stay on topic. 6 V0000000
Technical Writers Workflow CONFIDENTIAL designator What technical documentation should not be? Long Don t try to educating the reader on everything there is to know about the subject at hand. Complex Use simple language. Emotional Emotional language has no place in technical writing. Anthropomorphic Don t attribute human traits to non-human entities. 7 V0000000
Technical Writers Workflow CONFIDENTIAL designator Reviewing your first draft SME review QA review Peer review 8 V0000000
CONFIDENTIAL designator Technical Writer s Workflow Any questions, comments, concerns? 9 V0000000
CONFIDENTIAL designator Thank you linkedin.com/company/red-hat youtube.com/user/RedHatVideos Red Hat is the world s leading provider of enterprise open source software solutions. Award-winning support, training, and consulting services make Red Hat a trusted adviser to the Fortune 500. facebook.com/redhatinc twitter.com/RedHat 10 V0000000
