Archive for the 'Editing' 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

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

50. Afterword

Thursday, November 9th, 2006

Fritjof Capra, in his book The Tao of Physics, explains the task of a technical writer as follows: “The notion that all scientific models and theories are approximate and that their verbal interpretations always suffer from the inaccuracy of our language was already commonly accepted by scientists at the beginning of th 20th century, when a new and completely unexpected development took place. The study of the world of atoms forced physicists to realise that our common language is not only inaccurate, but totally inadequate to describe the atomic and sub-atomic reality. Quantum theory and relativity theory, the two bases of modern physics, have made it clear that this reality transcends classical logic and that we cannot talk about it in ordinary language.”

That this theoretical sophistication will eventually filter through to the down-to-earth concepts of engineering is certain, and has probably happened already. As science continually reassesses itself in terms of its wider implications, engineering too will need to adapt to the new complexities and possibilities. Language will be forced to expand and develop in an attempt to remain abreast of the new philosophies. Even simple technical descriptions, essential for complete understanding, will need to reflect the depth of theoretical complexity inherent in modern devices.

Technical writers of the near future will be resourceful individuals. They will need to span disciplines even more than they do now. But while techniques move on, and change is there to be described, they will survive. And, with a bit of luck, prosper.

Next: 51. Reinforcements - The Field.

45. The Development Documentation System (DDS)

Sunday, September 10th, 2006

DDS is a documentation/methodology employed in system design. It can be used for both electrical and mechanical engineering disciplines, covering hardware, software, logic and functional dimensions. It has become a versatile tool for designers of any system, allowing detailed recording of progress as the project develops. It’s not a publications application, but more a methodology and information system for development purposes. Writers, however, may be involved in its implementation, and will refer to it during the writing of other project documentation. It is a good example of documentation and information organization systems, which is how we are using in here.

The Development Documentation System was begun in the Sixties by the Naval Applied Science Laboratory in America. Since then much work has been done on it in the UK, and it has been used effectively for some naval and military projects. A full account of the procedure can be found in the MoD’s Naval Weapons Specifications.

DDS uses a hierarchical approach to the recording of design information. The levels move from the general to the detailed: from the highest and broadest level (showing the system itself) through as many intermediate levels as are considered necessary, to the lowest (illustrating the smallest detail). The format used will depend on the engineering discipline involved, and whether the subject matter is software, hardware, function or logic orientated. Advantages of DDS include:

* Ease of update.
* Results of studies or analysis may be incorporated.
* Evolves with the project, allowing a dynamic approach to documentation.
* Provides a complete record of the design stages.
* Enables a testing philosophy to be formulated at an early phase of development.
* Allows a wide choice of record formats.
* Co-ordinates all design information without necessarily replacing standard publications’ procedures.
* Presents maximum information in minimum time.
* Excellent for monitoring progress.
* Encourages a systems approach to design which smoothes over any interface
problems.

DDS is an example of a systems approach to technical documentation which authors may not come across often unless working on military projects. Newer technology methods have developed and extended it to match the complexity of modern engineering design. But if a technical writer gets involved in a very large project, such as the development of an aircraft, he/she will be plunged into a documentation implementation arrangement very similar to DDS.

Next: 46. Diagnostic and Maintenance Documentation