Archive for the 'TechBiz Writing' Category

58. Technical Editing

Thursday, May 17th, 2007

Technical editors are often thought of as some way beneath technical authors in the food chain. In trade publishing, however, editors, of one sort or another, occupy positions from the very top (the Commissioning Editor or Editorial Director), through the middle ranks (the Production and Managing Editors), to almost the bottom of the heap (the freelance copyeditor).

In this module we will concern ourselves with the broad sweep of the publishing editor’s perspective, but, most of all, with that of the copyeditor/proofreader, with special emphasis on the technical field, where appropriate.

The Commissioning Editor
It’s the Commissioning Editor who sets the ball rolling for the publication of a book, either by taking a manuscript from an agent — or less commonly these days, the slush pile — or by commissioning a known writer to undertake the task. This editor is now under some threat by new ideas in the publishing business.

When S.I. Newhouse took over the American publishing giant Random House, a number of sweeping changes were implemented. Editorial decisions were placed under tight constraint and usually heavily influenced by accountancy criteria. As Andre Schiffrin, an editor at the time, puts it:

“It is only in retrospect that the inevitability of this pattern emerged, though we ought to have been able to identify it at the start. While initially claiming that he would leave editorial decisions alone, Newhouse soon made changes at Random House that moved it in a far more commercial direction. Random’s profitable college [educational] department (as opposed to its weak school line) was sold off early in the game; Newhouse was so eager to get rid of it that he was willing to sell it for half of what it subsequently fetched when it was resold.”

The proceeds of this sale were used to buy another, seemingly very profitable, publisher’s list. The problem was that the accountants — not totally au fait with the book market — had got it wrong. Millions were wasted buying other properties, and selling bits of Random House. Shiffrin continues:

“Despite his early promise of editorial independence, Newhouse soon became personally involved in acquiring and commissioning titles…He arranged for huge advances to be paid to figures who clearly had very little to say in public but whose names were supposed to attract the curious masses.”

We cite the above passages to highlight the current plight of serious authors and editors within the publishing business, and the cavalier way some technical writing has been treated by the big boys of the print world. Thankfully, other specialist companies have stepped in and we are now seeing the emergence of a thriving print and electronic market in technical, especially IT, content and writing.

The Commissioning Editor, then, pursues publishable books in a variety of ways, whether through auctions with other publishers, or by in-house means. It’s the most entrepreneurial role in publishing, and if this is the route you would like to go you must be very well educated, very well connected, have a total grounding in the publishing world, a great enthusiasm for books, and be able to present a case for buying snow to Eskimos. This is not an easy job to get and very few succeed in making it to the top. Those that do often become legends in their own lifetimes — others just think they are.

The commissioning editor also helps shape the book, holding the author’s hand during the process. At this level the editor is more concerned with the structure of the project, rather than the minutiae of the text or the grammar. Here is a description of a typical Commissioning Editor by a former one:

“The Senior Editor is first and foremost a voracious reader. She [and it most often is a she] reads everything from newspapers to novels, and from encyclopaedias and dictionaries to popular magazines. She is gregarious enough to get along with authors, illustrators, designers, and other editors, and to build good relationships with agents (an agent with whom she has a good working relationship is more likely to funnel worthwhile projects and good writers her way); she is aggressive enough to go after an author she admires and to ‘sell’ a project she loves to her colleagues. She is a risk taker, creative enough to follow her instincts rather than slavishly follow trends. She is also an optimist: she believes in her books and authors and is ready to go in to bat for them. She has to be flexible, because her day, if not her life, will involve a constant juggling of responsibilities. She is well organised and detail orientated, knowing how important it is to keep a ‘paper trail’ for each project. She is practical as well as idealistic, never forgetting that publishing is a business and that books are products as well as creations of the imagination. And, like every editor worth his salt, she has a lifelong love affair with — and respect for — words.”

If you match up to that considerable template, good luck, you can’t fail! One more quote; this time from Thomas McCormack, Editorial Director of St. Martin’s Press. Here Thomas lists the qualities required for a good top-level editor: “Intelligence, sensitivity, tact, articulateness, industry, patience, accessibility, promptness, orderliness, thoroughness, a capacity to work alone, a capacity to work with others. Plus sensibility and craft. No humans need apply.”

59. Stages of Editing

57. Reinforcements - Printing

Wednesday, April 11th, 2007

Printing
Categories of printing methods: Most modern technical documentation will be printed by fast laser, docuprint techniques, often in-house, leaving the writer considerable control over the final outcome. Still to be found, however, are three traditional methods of printing:

* Relief printing
* Intaglio printing
* Planographic printing.

Relief printingTechnical Illustrations

Diagrams
Diagrams are two-dimensional line representations, usually intended for line plate reproduction. They are used in the presentation of symbolic, statistical, and functional information.

Line illustrations
Reproduction of line illustrations: These pictorial drawings are reproduced in a single solid colour with no tonal gradation. They have no intermediate grey tones and consist entirely of lines, dots or solids.
Perspective drawings: Realism is added to line illustrations by means of perspective:

* One-point (parallel)
* Two-point (angular)
* Three-point (oblique)

Three-point perspective is usually incorporated in technical illustration because it is the only form which allows the depiction of three faces of an object without distortion.

Vanishing points are dots placed at the periphery of a perspective drawing to which parallel lines apparently converge. This gives the impression of actual perspective on a two-dimensional plane. In three-point perspective, three vanishing points are used.

Half-tones
Half-tone process: is used to reproduce any subject employing continuous tonal gradation. The material is overlaid with a screened negative or glass plate, which breaks up the image into a pattern of dots of apparently varying density.

Validating technical illustrations
Checklist for vetting illustrations:

* Has spec been followed?
* Is format right?
* Are there technical errors?
* Is title correct?
* Is lettering of sufficient size?
* Are page and figure numbers correct?
* Is security marking accurate?
* Are layout and composition clear?
* Is line thickness correct?
* Are cross-references correct?
* Is material crossing spine clear?
* Is shading correctly placed?
* Have tints or colour codes been correctly indexed?

Next : 58. Technical Editing.

56. Reinforcements – Final Draft

Saturday, March 17th, 2007

Final draft
Copy preparation: The following points should be observed when preparing copy for the typist or compositor:

* Use double spacing
* Type or print on one side of the paper
* Be legible
* Number each sheet consecutively
* Circle keying instruction so that they don’t become part of the text
* Conform to house style.

Cast off: Estimating the length of a document in terms of pages. Word processor packages, like MS Word, will give you the number of characters and words. No-one manually estimates these now.
Prelims: Preliminary pages. These may be:

* Half-title page
* Half-title verso
* Title page
* Title verso
* Preface/foreword
* Contents list
* List of illustrations.

End pages: The final pages in a book following the body text:

* Conclusions
* Postscript
* Glossary
* Notes/references
* Appendixes/annexes
* Bibliography
* Index.

Production Phase

Proofreading
Types of proof: There are three types of proof in the traditional printing process:

* Galley proofs
* Page proofs
* Machine proofs.

There is also an intermediate stage of proofing referred to as “page-on-galley” proofs. The first two categories indicate the textual arrangement of the type, but not the final print finish. The machine proof approximates this quality.
Corrections at proof stage: Two types of correction are acknowledged by printers:

* Compositors’ errors corrected by printer or author.
* Author’s corrections indicated during proofreading.

The first are usually made gratis, but the second may be limited to 10% of the total cost of composition.

Next : 57. Reinforcements - Printing

54. Outline and Design Part 3

Thursday, January 18th, 2007

Information gathering
Data management: The problems associated with technical information revolve around:

* Accumulation
* Retention
* Accessibility

Printed information: May come in the form of:

* Previous manuals
* Sales documents
* Specifications
* Test schedules
* Parts catalogues
* Diagrams and drawings.

Verbal information: The most difficult to deal with in that it requires use of memory, notetaking, and/or tape recordings.
Visual information: All authors should have sight of the equipment they are writing about. This information is best stored in sketch or photographic form.

The synopsis
Defines the topic breakdown chapter by chapter and section by section. It includes the amount of detail to be covered, and the number and type of illustrations to be used. It should comprise:

* Chapter number
* Provisional title of chapter
* Subject of chapter
* Topic breakdown
* Illustrations
* Page estimate
* Other remarks.

Costing
Writing terms: Writing tasks are usually undertaken on the adjacent terms:

* Fixed price quotation
* Cost plus
* Limit of liability.

Office overheads: Approximately 125% of basic labour.
Cost of handbook: Labour + materials + office overheads.
Quotation charge to client: Cost + profit + VAT.

Next: 55. Reinforcements - Development.