Talk:Technical communication
From Wikipedia, the free encyclopedia
Contents |
[edit] Usability and Collaboration
One of the most important aspects of technical communication is the need for the information communicated to be useable, not just expository. As such, I felt it was important to add the word "useable" in front of "information." Likewise, collaboration factors into a lot of the work technical communicators do--enough so that it should be included here. --ISUengl314 11:35, 21 July 2006 (UTC)
[edit] Usability & Collaboration
This is my first edit, so I'm not quite sure what I'm doing here or how to use this page. (If I've added the comment incorrectly, please forgive me!) However, I've just added information about usability and collaboration to this page. This is important because technical communication isn't just about conveying information; it is about conveying information that people can use, thus information that is useable. Likewise, technical communicators often work collaboratively and anyone thinking about tech comm as a career (we have a job list here) needs to know that they should be good at teamwork. --ISUengl314 11:40, 21 July 2006 (UTC)
[edit] Stuff removed from article
I've just removed all this text, which is specifically about technical WRITING and really ought to be merged into technical writer or some other appropriate article. Need a more general description of **technical communication**, which is what this is about. Elf | Talk 05:50, 20 March 2006 (UTC)
(start of removed text)
[edit] Style
Information products developed by technical communicators are written in a style that is clear and concise. Paragraphs tend to be short and refer to a single topic. The length of sentences is kept to a minimum for easy reading. Important information is presented at the beginning followed by any details that may be required to provide explanation of the main topic. Technical communicators avoid the use of unnecesary words and long complex sentence structures. They also avoid the use of intensifiers unless these are essential.
The use of style guides will assist technical communicators to maintain consistency in their writing, especially where they are working in teams.
[edit] Presentation
The presentation of the content must ensure the clarity of the information. How the text and graphical elements are presented will depend on the means by which the material is being delivered to the audience, on paper or online. Headings are used to signal content, white space allows the reader to clearly define the blocks of information available. Colour must be used with care - can it be easily read, does it have cultural significance and meaning?
[edit] Text Formatting
Formatting must not distract the audience or make it difficult for them to read the information. The number of fonts used are kept to a minimum.
Format guides or templates make for efficiency in business of formatting documentation, and control the way that formatting elements are used.
[edit] Graphical Elements
Adding graphical elements, such as figures, illustrations, and tables can help the reader to more easily identify and understand the information being delivered. It is important that use of graphical elements is consistent and supports the purpose of the documentation. Care must be taken to ensure that the culture of the intended audience is taken into account when using graphical elements.
Figures may include pictures of any type, tables, equations or graphs. It is important that only the part of a figure pertinent to the topic is displayed. This may mean cropping a picture, trimming a table or magnifying part of a graph. Done properly, such modifications reduce visual activity and direct the reader to the information that matters.
The illustrations you use will depend on factors such as means of publication, availability of material, and requirements of the audience. Illustrations can be diagrams, graphs, line drawings, screen captures, or photographs. Care must be taken to ensure that the elements of the illustration can be easily read by the audience via the medium by which it is being delivered.
Tables should avoid cell fills unless this contributes to understanding and meaning. Borders are always stripped to those necessary; usually only that between the header and data is kept, though even that may be removed if the header text is bold. (Having both a border and bold text redundantly expresses the superiority of the header.)
(end of removed text)
