The five-way access system of the Handbook of Technical Writing . Using PDF Files . Previously, he worked in advertising, technical writing, and. Technical Writing. Nicole Kelley. Program in Writing and Humanistic Studies @ MIT. , Fall and “The Science of Scientific Writing” by Gopen and Swan. Technical writing tutorial. Purpose: To learn how to communicate technical information in writing. Importance: The main modes of communication are written, .
|Language:||English, Spanish, Indonesian|
|ePub File Size:||21.39 MB|
|PDF File Size:||15.18 MB|
|Distribution:||Free* [*Register to download]|
jor types of documents in technical writing can be grouped into four major .. This publication is being made available in PDF format as a benefit to members. Chapter One not only provides a rationale for teaching technical writing, but also defines technical writing and compares/contrasts it to other types of written. Technical Writing Guide. Michigan State University. Department of Biosystems and Agricultural Engineering. Farrall Hall, East Lansing, Michigan.
All you need is some information about the product, and youre ready to start writingwriting a documentation plan and an outline, that is. You probably want to start writing the content instead of spending time on plans and outlines, but up-front planning and analysis are critical to good content. Formulating doc plans and outlines is the best way to complete this analysis. The time you spend planning your content is an investment; youll find that good planning saves you a lot of time later in the project. Please do not share or redistribute. Chapter 3: Very necessary evilsdoc plans and outlines In other words, you can plan at the beginning, or pay for it when you flounder in the middle of the project.
Receivableswhat the writers and other documentation team members need from others such as the latest version of the product, access to the developers to get questions answered, existing content, and a template from the template designer. Chapter 3: Very necessary evilsdoc plans and outlines Stylewhat style guidelines will be followed such as in-house style guidelines and The Chicago Manual of Style.
Taskslist of the actions required to complete the project and who is responsible for them. For example, the documentation team will handle information gathering, writing, editing, production editing, and indexing. The product developers will provide technical assistance and ensure the accuracy of content.
Toolswhat tools such as desktop publishing and graphics software the documentation team will use to create the content.
Chapter 4, The Tech Writers Toolbox, provides more information about tools. Schedulesa schedule for each deliverable see Any formulas for writing doc plans?
A schedule should also include dates for editing, illustration, indexing, and preparation for final output print, online, or both. Sometimes, the doc plan itself is a deliverable, particularly if youre a freelance or independent writer.
Even if youre not required to deliver the doc plan to your client or your internal customers such as the development team , its a good idea to let them see the doc plan to ensure that everyone understands what they need to do to keep the deliverables on schedule.
Doc plans for external clients If you are producing a documentation plan for an external client, the plan should also include the following items: Copyrightwho will own the copyright of the completed content.
Its critical to spell out whether and how the copyright is transferred from the writer to the client company. If youre in business on your own, get advice from an attorney on how to word this section of your proposal or documentation plan. Costa breakdown of the cost for each deliverable see Any formulas for writing doc plans? Cost may be a fixed price or an hourly rate.
DisclaimerAll doc plans, contracts, and legal paperwork exchanged with a client should state that technical accuracy is the responsibility of the client or developer. For example, you could add the following text to your doc plan: Technical Communication Company will make a reasonable effort to ensure the technical accuracy and completeness of the materials delivered to Client.
However, Client is ultimately responsible for the content of the content. Client will review content for accuracy and completeness, and identify required changes to Technical Communication Company before the final delivery. Termspayment schedule, cancellation policy, and other legal information.
Who writes the doc plan? In a group of writers or a documentation department, a senior writer or manager usually writes the documentation plan. However, if youre the only writer at a company, youre it. Take the time to write a doc planeven if its an informal document you dont show to anyone else. As you create the plan, youre forced to think about schedules, audience, and so on.
Performing this analysis early in the project helps prevent nasty surprises later. Chapter 3: Very necessary evilsdoc plans and outlines If your plan requires commitments from other people, be sure to consult them before you publish your schedule. Have your doc plan edited if you plan to turn it over to an external clientparticularly when its part of a proposal.
A grammatical error or misspelling in a doc plan isnt going to improve your chances of getting the project, and it makes you look bad.
Any formulas for writing doc plans? A doc plan contains lots of numbers page counts, schedules, and so on , so you might wonder whether there are any formulas to help you calculate those numbers. Authored in FrameMaker. As sole technical writer, authored the manual including all GUI illustrations for the on-screen display.
Authored in Word, Corel. SciAn EDC Pro Study Configuration Guide topic user guide for contract research organization's flagship clinical data management software one of 14 docs.
As sole technical writer, developed all content and graphics, including cover design. Authored in Author-it and Visio. Output final to PDF. As sole technical writer for the company, single-sourced six manuals for six product platforms, and migrated the company from Word-based manuals to FrameMaker, including templates and technical writing manuals. FrameMaker Templates User Guide page doc helps VisualSonics staff create and edit documents based on the original FrameMaker templates I designed and built for the company.
VisualSonics Rail System Operator Manual page doc for a three-component lab research system that interfaces with the company's high resolution imaging system. As sole technical writer for the company, designed and authored the document in FrameMaker.
One in a series of these manuals for the company's line of solar powered municipal devices. As sole technical writer for a remote-only client, developed the content, templates and design.
SciAn CDM Manager User Guide As sole technical writer for the company, authored page doc for the launch of this contract research organization's flagship clinical data management software. Migrated the company from Word-based documentation to FrameMaker, including templates and technical writing manuals. SciAn Electronic Data Capture System User Guide As sole technical writer for the company, authored page doc for the launch of this contract research organization's online electronic data capture system for clinical trial sites.
As sole contract technical writer, designed and developed custom print output template and custom XHTML template for single-sourcing output. Developed topics and the term index.
ResourceMate Help topic online help system for ResourceMate, an automated system for managing library items, patrons and circulation. As sole contract technical writer, reconceived the help system, designed and developed custom print output template and custom XHTML and CHM templates for single-sourcing output, and developed all topics.
FM Help topic online help system for FM, an online fund management system for hedge fund managers. As sole contract technical writer, migrated the software company to a single-sourced authoring system, developed custom print output template and custom XHTML templates, and developed all topics. As sole technical writer for a remote-only client, designed and developed custom print output template and custom XHTML template for single-sourcing output.
As lead information developer, migrated Omnivex to single-sourcing platform, and trained writers to develop single-sourced content. Instructional materials technical writing examples Omnivex Moxie courses 8-module, exercise, page workbook for this hands-on 2-day course that teaches advanced features of Omnivex Moxie digital signage software. One of 5 equally sized courses I have conceived, produced and updated for the company.
Improving Your Documents With Technical Writing Skills module, exercise course that delivers you technical writing skills and concepts that staff can use instantly not only for manuals and guides but also for proposals, reports and any writing that needs to make technical content clear and persuasive.
Authored in Author-it and PowerPoint. Selling Managed Portfolio Services topic Web-based sales training module. One of seven authored for this major Canadian bank's module Selling Priority Products staff training course.
Document Management System Training Guide page take-away document. Linked to facilitator-based training of global IT group leaders for Big-5 accounting firm's national document management system. Writing, design, desktop publishing. Financial Pursuit page personal financial planning user guide. As lead editor, ghost-wrote selected chapters, and edited for author Graydon Watters in As I write this, used copies are still available on site for about forty dollars.
Held its value pretty well over the decades. In , ghost-wrote and edited the book for the now late Paul Witz. As I write this, new copies are available on site for about 25 dollars, and used copies are available for one cent.
What can I say. Marketing content technical writing examples Leitch Technology - Neo brochure page brochure. One of four brochures for the company introducing integrated modular television broadcast platforms, and a broadcast network control system. Writing only. Advantex annual report page document for a loyalty marketing company serving institutions with large customer databases.