Technical documents provide information that readers need to make decisions or complete tasks. Technical editing ensures that this information is presented in a way that facilitates the reader's understanding. Technical editors offer suggestions for improvement in design of both content and layout and therefore work with the document in both early and late stages.
#29519
Un weblog qui cherche à servir de coin aux auteurs techniques.
Flacke, Marie-Louise. Rédacteur Technique, Le (2007). (French) Resources>Writing>Technical Editing>Technical Writing
#23921
#14046
Grâce à ce site, vous découvrirez peut-être le métier de rédacteur technique ainsi que ses multiples intérêts pour l'entreprise. On y parle de documentation papier bien sûr mais aussi de tous les nouveaux supports désormais utilisés pour aider les utilisateurs dans leur travail quotidien et leur formation (aide en ligne hlp, documents html, sites web...).
#26327
Regular expressions, sometimes referred to as regex, grep, or pattern matching, can be a very powerful tool and a tremendous time-saver with a broad range of application. As an extended form of find-and-replace, you can use a regular expression to do things such as perform client-side validation of email addresses and phone numbers, search multiple documents for strings and patterns you wish to change or remove, or extract a list of links from source code. Regex is supported by most languages and tools, but because there can be varying implementations, this article will cover basic principles that are commonly used.
Spruck, Chris. evolt (2005). Articles>Editing>Search>Regular Expressions
#26464
Grundlagenwissen, Checklisten, Tools und Links, die Ihnen beim Schreiben benutzerfreundlicher Handbücher, Online-Hilfen, Software-Demos, Tutorials und anderer Formen der Benutzerunterstützung ("User Assistance") helfen.
Achtelig, Marc. indoition engineering (2005). (German) Resources>Information Design>Technical Editing
#21433
Von dieser Seite aus erreichen Sie ganz konzentriert Angebote im Internet, die für Übersetzer und Technische Redakteure besonders interessant sind. Naürlich gibt es auch in dieser Linklisten, getrennt für Übersetzer und Technische Redakteure. Bei Bedarf erscheinen Themen auch in beiden Listen, Sie können sich also wohl auf eine der Listen konzentrieren.
von Obert, Alexander. Techwriter.de (2003). (German) Resources>Directories>Technical Editing>Localization
#22316
Restore A Photograph Like A Pro: Photoshop Tutorial 
Below is the photo we'll be restoring. You can right-click and copy it so that you can follow along in this lesson.
Vanderwood, Jacquelin. Photoshop Today (2004). Design>Graphic Design>Image Editing>Adobe Photoshop
#22541
Time isn't kind to treasured photographs. See Photoshop Diva Katrin Eismann's digital techniques for repairing creased, stained, torn, and damaged photos.
Eismann, Katrin. Creative Pro (2004). Design>Graphic Design>Image Editing>Adobe Photoshop
#30564
If we've been asked by a peer to review his or her work before it is sent out to be scrutinized by the world, our job is to neither edit nor rewrite the information. Our job is to give helpful, specific feedback about where the information communicates well and where it needs work. The more we understand about how to review a peer's work effectively, and how doing this is different from editing, the better feedback we can provide.
Gillihan, Dana L. STC Proceedings (1993). Articles>Collaboration>Editing>Writing
#14281
One of the best ways to practice writing memos, of course, is to get a job and write lots of memos to actual audiences, but practicing can certainly help. This computer file contains a memo that needs to be revised. In the current version, the main points are difficult to locate, and the supporting details aren’t well organized. You will work to improve this memo to make it work more effectively with its audience.
Burnett, Rebecca E. Thomson (2001). Academic>Course Materials>Editing
#14267
Revising Documents for Different Audiences 
In the most effective documents, the data is presented in the way most appropriate for the readers. It matches their expectations for the document, their purposes for reading, and their level of technical expertise. When professionals create documents, they must be mainly concerned with the primary reader. To ensure that you are thinking about your readers, it is often useful to create a reader profile, identifying their key characteristics. This profile allows you to shape the material into a more reader-friendly document. During this exercise, you are going to create an information sheet about melanoma. This exercise has two major stages. First you will complete an audience analysis worksheet by answering questions about your primary audience. Then you will revise text about melanoma of the skin, creating a one-page information sheet that could be distributed to students at a campus science exhibition.
Burnett, Rebecca E. Thomson (2001). Academic>Course Materials>Editing
#29785
Rhetoric 3301.03: Editing for Usage, Style and Clarity
Rhetoric 3301 is a writing course in which students work to improve their writing style and clarity while studying the conventions of standard usage.
Nahrwold, Cynthia. University of Arkansas-Little Rock (2002). Academic>Courses>Editing
#29787
Rhetoric 5/4304: Technical Style and Editing
Rhetoric 5/4304 emphasizes the editing process of technical materials, which includes the following: knowing different levels of editing, copyediting and proofreading, editing for organization and content, editing graphics, editing for effective document design, and learning how to work effectively and efficiently as a team member. We'll do hands-on editing to give you necessary knowledge/practice and to develop your editing skills.
Nahrwold, Cynthia. University of Arkansas-Little Rock (2002). Academic>Courses>Editing>Technical Editing
#21909
Ever wonder why some graphics file formats have a poor reputation? Sometimes, it's not because they're inherently bad, but because they're not designed to be used in certain ways, on certain printers, or on certain platforms. Knowing how to match a job with the right formats can save you some real headaches.
Kvern, Olav Martin. Adobe Magazine (1997). Design>Graphic Design>Image Editing>Standards
#30339
The Role of Indexing in Technical Communication
The success of a technical document depends heavily on the index. The task of indexing a technical document often cannot begin until insufficient time remains to do a good job. However, for many users of the document, a good index is mandatory to its usability.
Northrop, Mary Jane. Boston Broadside (1993). Articles>Editing>Indexing
#22113
The Role of the Editor in the Technical Writing Team
Editing today covers far more than printed materials. In this discussion, I am assuming a technical editor may be required to deal with: printed materials (for example, books, pamphlets, quick reference cards); electronic (for example, online documentation, online help, web pages); video scripts; computer-based training materials. I am also assuming that the audience for the material being edited is not comprised of other technical people; or if it is, the editor is not the person responsible for ensuring the technical accuracy of the material.
Hollis Weber, Jean. Technical Editors Eyrie (2002). Articles>Editing>Collaboration>Technical Writing
#14144
This document is about making screen captures for technical writers working primarily in a Microsoft Windows environment. The tools targeted include Adobe FrameMaker, Microsoft Word, Adobe Acrobat, along with Techsmith’s SnagIt, Adobe Photoshop, and Ulead’s PhotoImpact 4.2. Certainly, the thoughts and techniques mentioned herein can be applied to other professions, other operating systems, and other tools.
Brierley, Sean. TECHWR-L. Books>Documentation>Image Editing>Screen Captures
#18556
'See also' cross-references assist the user to quickly navigate to the right index term. The same principles that apply to 'See also' cross-references apply equally to hypertext linking. 'See also' cross-references are constructed using the following relationships: a broader term to a narrower term, e.g. 'mammals, See also whales'; sailing craft, See also hulls overlapping meaning between two terms, e.g. 'gold, See also money'
Brown, Fred. Allegro Time! (2000). Articles>Indexing>Editing
#29684
Sentence Diagramming: Making Sense of Sentences
Sentence diagramming is an important tool for technical communicators to use in analyzing their own writing and editing. Sentence diagramming is also a neutral basis from which to discuss and evaluate technical documentation with colleagues and with other co- workers, such as subject-matter experts, who are not professional communicators. Through visual examples, this paper illustrates how to diagram three types of sentences (simple, compound, and complex), how sentence diagramming shows an objective view of three common syntactical errors (misplaced modifier, lack of parallel structure, and dangling modifier), and how the revised sentences make sense as sentences and as diagrams.
Ball, Valerie M. STC Proceedings (2005). Articles>Editing>Grammar
#24611
Seven Discrete Principles for Content Editing
One of many lessons I learned in 30 years of Technical Editing was to separate myself from the crowd by learning to edit technical content, using seven reader-oriented techniques.
Bush, Donald W. STC Proceedings (1996). Articles>Editing>Technical Editing
#28164
A SIG Transformation: Past, Present, and Future
A recent discussion about the STC's Technical Editing Special Interest Group (TE SIG) provided insights into the evolving role of communities of interest in the Society. At a meeting of the Carolina Chapter's local TE SIG, Diane Feldman, who is the manager of the Society-level SIG, provided members with an update on SIG activities.
Brautman, Heather. Carolina Communique (2005). Articles>TC>Technical Editing>STC
#20571
Situational Editing: A Rhetorical Approach for the Technical Editor 
Argues that the rhetorical approach to communication considers situations individually and is necessary for technical editors because their work comprises a series of individual rhetorical decisions. Proposes a rhetorical theory of technical editing.
Beuhler, Mary Fran. Technical Communication Online (2003). Articles>Editing>Technical Editing>Rhetoric
#20136
Six Steps to Producing an Index
If something does not appear in the index, it might as well not be in the book because the reader may never find it. Writing a complete index takes time and patience. Writing an index that is consistent and effective requires refinement and common sense. Here are six steps that will get you through the process.
Winsberg, Freya Y. STC Proceedings (1996). Articles>Indexing>Editing
#14418
The Slot: A Spot for Copy Editors
In the old days, copy desks were shaped like horseshoes. The leader sat in the middle, or 'slot,' and was known as the 'slot man,' or 'slot' for short. (In the old days, everybody was a man.) If you're looking for more information about copy editing as a profession, this is the journal for you. You'll also find advice on how to become a copy editor.
#29417
Most technical communicators are hired primarily as writers and creators of information, but despite this, many of us must learn how to edit at some point. Whether the reasons are good (to prepare better first drafts for review) or bad (your employer won't pay for a full-time editorial position), the reality is inescapable: at some point you're going to have to edit your own writing or that of a colleague. The problem is that editing requires an entirely different mindset than writing, and it's difficult to make the mental shift from creating to revising.
Hart, Geoffrey J.S. Geoff-Hart.com (1998). Careers>Editing>Technical Editing
