Transcript Document
Steps Plan Activities • Define scope, stakeholders & process • Select techniques & tools • Review Doc. Plan with stakeholders • Schedule project • Check for templates or style guides • Gather information • Track progress • Create table of contents (if required) • Review table of contents with subject matter experts / stakeholders • Write first draft • Review draft with subject matter experts • Review & revise draft to final stage • Format / lay out draft • Edit & check draft • Define review team • Conduct stakeholder review • Collate feedback & revise draft • Obtain approval to publish • Finalise document (formatting, proofreading, etc.) • Establish document control • Publish final draft • Communicate with stakeholders • Technical Writing Process • Documentation Plan • Documentation Timeline / Schedule • Deliverables Matrix / Worksheet* • Status Tracker* • Table of Contents Tools / Outputs Technical Writing Process • Drafts (First, Interim, Final) • • • • • Controlled Document • Message to Stakeholders Structure *For projects with multiple deliverables Write Review Publish Editing Checklist Editing Sheet Review Matrix Message to Review Team • Review Log • Approved Draft Terms of Use Copyright The Technical Writing Process e-book, hardcopy book, website, and diagram are copyright © Kieran Morgan 2014. On purchase, download or use of the Technical Writing Process book (either the hardcopy or e-book versions, or any versions published in any other format), website, diagram, or templates, you agree to the following terms: • Main Work. “Main Work” includes everything in the book apart from the templates depicted in the Templates appendix. The Main Work is copyrighted. No part of the Main Work may be reproduced, transmitted, downloaded or stored in any information storage and retrieval system, whether electronic or mechanical, whether known now or invented in the future, without the express written permission of the publisher, Better On Paper Publications. • Templates. “Templates” are the templates depicted in the Templates appendix of the book and available for download from TechnicalWritingProcess.com. The Templates are copyright. On purchase or use of the book, e-book or the downloadable Templates, you are granted a license to edit and amend the Templates to make them suitable for your purposes. You must not republish the Templates in unamended form. You must not sell or redistribute the Templates or derivatives of the Templates. No warranties or representations are provided concerning the Templates, and no liability is accepted in relation to their use. Requests and inquiries concerning reproduction and rights of the Main Work or Templates should be addressed in writing to the publisher, Better On Paper Publications. Publisher The publisher of this book (including the hardcopy and e-book versions, and any versions published in any other format) and templates (including the templates depicted in the book as well as the downloadable templates) is Better On Paper Publications. Contact the publisher using the contact form on the website TechnicalWritingProcess.com, or by mail at: Better On Paper Publications PO Box 494 St Leonards NSW 1590 AUSTRALIA Disclaimer While the publisher and author have used their best efforts in preparing the Technical Writing Process website, templates, diagram, and book (including the hardcopy and e-book versions, and any versions published in any other format), they make no representations or warranties with respect to the accuracy or completeness of the contents of the Technical Writing Process website, templates, diagram, and book and specifically disclaim any implied warranties of merchantability or fitness for a particular purpose. The Technical Writing Process website, templates, diagram, and book does not purport to be legal advice, and it is provided as a general guide only. The advice, information and templates contained within the Technical Writing Process website, templates, diagram, and book may not be suitable for your situation. Some advice, information or templates in the Technical Writing Process website, templates, diagram, and book may become superseded due to changes in industry practice, technology or law. Neither the publisher nor the author shall be liable for any loss or other damages that may be incurred as a result of using the templates or acting on the advice or information contained in the Technical Writing Process website, templates, diagram, and book. Trademarks The Technical Writing Process diagram is a trademark of Kieran Morgan. Adobe, Acrobat, FrameMaker, InDesign and Photoshop are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and / or other countries. Apache and OpenOffice are trademarks of The Apache Software Foundation. Author-it is a registered trademark of Author-it Software Corporation. BPMN is a trademark of Object Management Group, Inc. in the United States and / or other countries. DITA is a trademark of OASIS, the open standards consortium where the DITA specification is owned and developed. Flare is the trademark of MadCap Software, Inc. in the United States and / or other countries. ISO is a registered trademark of the International Organization for Standardization. Microsoft, Excel, PowerPoint, SharePoint and Visio are either registered trademarks or trademarks of Microsoft Corporation in the United States and / or other countries. TechSmith and Snagit are registered trademarks of TechSmith Corporation. All other trademarks and registered trademarks are the property of their respective owners.