http://tc.eserver.org/dir/Reference/Writing/Technical-Writing A listing of the most recently indexed works about Reference and Writing and Technical Writing in the field of technical communication (and technical writing). en-us Copyright (c) 2005-08 by the EServer. All rights reserved. tclib-editorial@eserver.org (TC Library Editorial Board) webmaster@eserver.org (Geoffrey Sauer) http://tc.eserver.org/images/newlogo.gif http://tc.eserver.org/dir/Reference/Writing/Technical-Writing http://tc.eserver.org/35804.html http://tc.eserver.org/35804.html I’m working on a project to boil a 150-page software user document down to a one-page reference guide that can be tacked to a CSR’s cube wall. Our goal with the one-page reference guide is to give the CSR a description of all the navigation elements and application functionality so they can quickly navigate to where they want to go without first having to trudge through the complete 150-page user doc. http://tc.eserver.org/34382.html http://tc.eserver.org/34382.html Users often want documentation in a format that will give them the basics and get them on their way as fast as possible. Quick reference guides provide a short version of a manual, condensed from dozens or hundreds of pages down to just one double-sided sheet of paper. Despite the brevity of quick reference material, the thought process involved in creating, organizing, and laying out the content is time consuming. The format requires you to assess the content and decide the most important information the user needs to know. You must describe with extreme concision and clarity processes that usually require dozens of pages to explain. This article provides an overview of the strategies, tips, challenges, and benefits we have learned in using quick reference guides for our documentation projects. http://tc.eserver.org/34252.html http://tc.eserver.org/34252.html In this article, my colleague and I provide strategies, tips, and approaches we’ve learned in creating quick reference guides for software documentation projects. http://tc.eserver.org/34159.html http://tc.eserver.org/34159.html This set of guidelines was developed to help you understand the expectations for technical communication in CE 314K (Properties and Behavior of Engineering Materials). Successful technical communication requires practice. Therefore, you should allot sufficient time to write several drafts of each assignment before submitting the final version. http://tc.eserver.org/26969.html http://tc.eserver.org/26969.html Il processo di comunicazione tecnica consiste nel veicolare informazioni circa una tecnologia ad una platea ben definita. http://tc.eserver.org/24963.html http://tc.eserver.org/24963.html A hypertext encyclopedia entry about technical writers, with links to many related topics. http://tc.eserver.org/24117.html http://tc.eserver.org/24117.html This outline is provided to help introduce the Technical Report and to clarify the acceptable format and level of achievement that is considered essential for successful completion of the Technical Report. http://tc.eserver.org/23503.html http://tc.eserver.org/23503.html Language Across the Curriculum in Applied Science and Engineering at the University of Toronto helps students to communicate in writing and orally. http://tc.eserver.org/23502.html http://tc.eserver.org/23502.html The rules here apply to all classes in the Chemical Engineering Department at Ohio University. Most of them will apply in 'the real world', too, although your employer may have some specific format requirements. http://tc.eserver.org/20712.html http://tc.eserver.org/20712.html Style manuals show how to format bibliographies and footnotes; some also provide information on outlining, editing and writing. If your instructor has not specified a particular format or recommended a style manual, consult one of the following, widely-used manuals. http://tc.eserver.org/19711.html http://tc.eserver.org/19711.html The May 2003 edition of the standard reference for Apple publications. http://tc.eserver.org/13518.html http://tc.eserver.org/13518.html An updated version of the style guide used by writers and editors in Apple publications groups. http://tc.eserver.org/10681.html http://tc.eserver.org/10681.html MS Help 2.x was announced at WinWriters on March 5, 2001. MS Help 2 is the help system used by Visual Studio .NET help and MSDN Library, and now the Borland .NET IDEs. Getting started with MS Help 2.0? This site is a start.