Cover Page ofThe Mayfield Handbook of Technical & Scientific Writing
Table of ContentsWriting TimelineHelpCredits

Section 2.8.2.1

Technical Documentation

Technical documentation is system description aimed at thetechnical specialist who needs to understand the systems designin sufficient detail to be able to apply, repair, modify,enhance, or add on to the system. Technical documentation isaddressed to technician or expert audiences in the same terms used by theoriginal designer:

Original computer code

Wiring diagrams

Detailed system specifications

Detailed design drawings

Technical documentation normally includes a system overview,design drawings, including wiring diagrams, computer codes,component descriptions, and technical specifications.

The following is a short excerpt from a technical referencemanual on the Hypertext Markup Language (HTML).


Special Characters

Minimum Attributes

The leading ampersand is required. The ampersand and semicolondelimit an entity name which the user agent will replace with aspecial character. The trailing semicolon is necessary when thecharacter following the entity is not a space or end of line.It is never incorrect to include the trailing semicolon.

These main four special characters are specifically included inRFC 1866.

&lt; < (less than sign)
&gt; > (greater than sign)
&amp; & (The ampersand sign itself)
&quot; " (quote character)

--Sandia National Laboratories, HTML ReferenceManual


Reference Link Text
## Technical Documentation ##
Reference Link Text

[ Home | Table of Contents| Writing Timeline | Index |Help | Credits]

Copyright ©2001 The McGraw-Hill Companies. Any use is subject to the Terms of Use and Privacy Policy. McGraw-Hill Higher Education is one of the many fine businesses of
The McGraw-Hill Companies, Inc.
.
Corporate Link