This online technical writing book now uses technical document (techdoc for short) to refer to any document that contains tecnical information—as opposed to using report. The report is a subcategory along witb the other kinds of technical documents discussed in this book.
Note: This technical Writing textbook focuses on technical writing skills. The technical content here is not guaranteed to be accurate or up to date.
Background/informational reports
This type is the hardest one to define but the one that most people write. It focuses on a technical topic, provides background on that topic for a specific set of readers who have specific needs for it. This report does not supply instructions, nor does it supply recommendations in any systematic way, nor does it report new and original data.
For a complete chapter on this type of techdoc, see background/informational reports
Business plans
A business plan is a document used to start a new business or get funding for a business that is changing in some significant way. Business plans are important documents for business partners who need to agree upon their plans, government officials who need to approve that plan, and of course potential investors such as banks or private individuals who may fund the business.
See the complete chapter on this type of techdoc.
Computer user guides
Briefly defined, a computer user guide provides technical information on how to computer hardware or software, including directions on such tasks as setup, configration, andesnial tasks.
See the complete chapter on this type of techdoc.
Data reports
A data report is a technical document containing lots of data in the form of tables. It also may contain charts and graphs that more vividly depict the data in those tables and explanatory cross-references stating key trends and conclusions in the tabular data.
See the complete chapter on this type of techdoc.
Design reports
An engineering design report introduces and documents an engineering design project so that others can understand how the design can be applied and commercialized. Engineering students, for example, have written about the design of a temperature measurement and display system using a microcontroller.
See the complete chapter on this type of techdoc.
Guides and guidance documents
Briefly defined, a guide is publication that provides step-by-step instructions, tips, related concepts. It can also contain troubleshooting information, links to related communities, and links to related research.
A guidance document is a governmental documents intended to provide helpful information to the public, such as clarifying obligations under an existing law or regulation. It attempt to translate the complex legal language of administrative rules to enable the public to abide by those rules.
See the complete chapter on these types of techdoc.
Handbooks
Briefly defined, a handbook is a ??? source containing conceptual informtion (basic theories, principles, fundamentals), instructional information (step-by-step directions), and reference information (quick look-up information).
See the complete chapter on this type of techdoc.
Instructions
Briefly defined, instructions tell you how to build things, operate things, fix things—the classic "how-to."
See the complete chapter on this type of techdoc.
Literature reviews
Briefly defined, a literature review summarizes what is known about a specific research topic, narrates the milestones of the research history, indicates where current knowledge conflicts, and discusses areas where there are still unknowns.
See the complete chapter on this type of techdoc.
Primary research reports (lab reports)
Briefly defined, a primary research report presents findings and interpretation from laboratory or field research. You can think of it as a lab report, but it's much more than that.
See the complete chapter on this type of techdoc.
Progress reports
Briefly defined, a progress report informs a supervisor, associate, or customer about progress on a project over a certain period of time. The project can be the design, construction, or repair of something, the study or research of a problem or question, or the gathering of information on a technical subject.
See the complete chapter on this type of techdoc.
Proposals
Briefly defined, a proposal is an offer or bid to do a certain project for someone. What makes a proposal a proposal is that it asks the audience to approve, fund, or grant permission to do the proposed project.
See the complete chapter on this type of techdoc.
Recommendation, feasibility, evaluation reports
This group of similar reports does things like compare several options against a set of requirements and recommend one; considers an idea (plan, project) in terms of its "feasibility," for example, some combination of its technical, economical, social practicality or possibility; passes judgement on the worth or value of a thing by comparing it to a set of requirements (criteria).
See the complete chapter on these types of techdoc.
Standard operational policies and procedures
These are the operating documents for organizations; they contain rules and regulations on how the organization and its members are expected to perform. Policies and procedures are like instructions, but they go much further. Standard operating procedures (SOPs) are more for procedures in which a process is performed—for example, taking a dental impression.
See the complete chapter on these types of techdoc.
White papers
Briefly defined, a white paper is a technology or business document that provides background on a project (device, method, etc.) and advocates for it. White papers have become popular marketing tools for corporations especially on the Internet since many potential customers search for information on the Web. Corporations use white papers to sell information or new products as solutions that would serve their customers' needs.
See the complete chapter on this type of techdoc.
