Sunday, August 3, 2008

Reading Technical Information & Documents

Reading Technical Information:
Technical information is typically less friendly than other information. It is often complex and assumes a high level of initial knowledge.

Manuals are often badly written - a manual is often supplied with a product purely because it is expected. In many cases it will have been given to a junior member of staff to prepare, and will not have been properly edited or reviewed.

Before wading into technical documentation, assess who it has been written for. Is it too basic to meet your needs, or is it so advanced that you cannot understand it? In the latter case it may be more cost effective to bring in an expert to do the job.

If referring to specific information, it is most effective to use the table of contents and index to find the appropriate section.

If you are reading large amounts of the material, it may be effective to photocopy the glossary, and keep this beside you. It will probably also be useful to note down the key concepts in your own words, and refer to them when necessary. Usually the most effective way of making notes is to use Mind Maps. As with other sorts of material it may be most effective to skim the material before reading it in depth.

Reading The 'Whole Subject' Documents:
When you are reading a document, such as a company report, which purports to give an overall analysis of a subject, it is easy to accept the writer's structure of thought, and miss the fact that important information has been omitted or that irrelevant detail has been included.

Where you are reviewing this sort of document, an effective technique is to compile your own table of contents headings before you open the document. You can then use this table of contents to read the document in the order that you want.

Using this technique will allow you to spot where important information is missing or has been obscured, and helps you to avoid trivia. If the writer has a better knowledge of the structure of the topic, this helps you to recognise and adjust your initial view of the best structure.

No comments: