Tech Biz Writing

Requirement
Identification of requirement: The adjacent points identify the key areas in eliciting a client’s requirements:

* Specification
* Target readership
* Deadline
* Information available
* Maintenance philosophy
* Subcontractors involved
* Commercial parts incorporated
* Author’s contacts
* Validation procedure
* Editorial procedure
* Documentation meetings.

Specification
Specification is a document prepared by an authority as a basis for the production of technical literature. In addition, we use this term to cover the format, length, and presentation of the document. As well as British Standards, there are many military and civil specs.

Outline design
The outline design anticipates:

* The information an author will need
* The synopsis of the document
* The cost estimate of the work to be done.

It summarises both the specification and the requirement, and looks forward to the sources and type of data that will be needed.

Sources of information
Types of information: Information may come in three ways:

* Printed information
* Verbal information
* Visual information.

The British Library: The national library of Great Britain which has a number of branches useful to the technology researcher.
Classification system: Methods — numeric or alpha-numeric — of allotting to publications a specific classification which distinguishes them from others.
Information search sequence: The following step by step sequence outlines a logical procedure for researching information at a library:

1. Establish subject areas and terminology.
2. Extract classifications from library catalogues.
3. Search index and directories for relevant publications.
4. Order publications not available at library.
5. Compile bibliography of the subject for further research.
6. Consult periodical indexes for state of the art data.
7. Obtain details of trade papers and journals from press guides.
8. Make list of relevant research organisations.
9. Examine year books for appropriate standards and specs.
10. Look through Patent indexes for useful information.

Universal Decimal classification: A ten-point classification system of which Class 6 refers to Applied Science and Technology, and 62 covers Engineering Sciences.
Library of Congress classification: An alpha-numeric method used to classify the publication stock of the US Library of Congress.
International Standard Book Number: A number prefaced by ISBN and found usually on the history page of most published books. Used extensively in computerised and tele-ordering systems.

To be Continued

Next: 53. Outline and Design Part 2.

This entry was posted on Wednesday, January 3rd, 2007 at 2:35 pm and is filed under Technical Writing, Publishing, TechBiz Writing, Documentation, Design. You can follow any responses to this entry through the RSS 2.0 feed. Responses are currently closed, but you can trackback from your own site.