MODULE 2-LESSON 4 Technical Literature

Objectives

 Introduce the different forms of Technical Literature

 Discuss and define the different types of technical reports

Introduction

Welcome to lesson 4 of module 2! In this lesson you will explore the different types of
technical reports. Enjoy this lesson and keep learning.

ABSTRACTION

TECHNICAL REPORT (also scientific report) is a document that describes the process, progress,
or results of technical or scientific research. Including in-depth experimental details, data, and
results. It might also include recommendations and conclusions of the research. Technical reports
are usually produced to report on a specific research need. They can serve as a report of
accountability to the organization funding the research. They provide access to the information
before it is published elsewhere.

\
 DIFFERENT TYPES OF TECHNICAL REPORTS

 Recommendation Report
- In this type of writing, you compare several options against a set of requirement as a
way to find one specific action to recommend.
 Research Report
- Presenting findings culled for research, both from the laboratories on certain field.
- Content of report is actual work someone does in a laboratory or in the field.
- Consisting of data, conclusion, methodology and background on the problem.
- To make reader ca easily understand the purpose and results of research.
 Technical Specifications
- A document that defines a set of requirements that a product of assembly must meet
or exceed.
- These documents present descriptive and operational information.
- Created for new products.
 Business Plans
- These are proposals for starting a new business, a formal statement of the business
goals and the plan for achieving them.
- To provide whatever information the audience may need to consider the idea.
 Background Reports
- Intended to provide background details on a technical reports.
- Focus on a specific topic meeting specific audience needs
- Two essential infrastructures of the background reports are definition and
classification
 Feasibility Report
- It is primary and most important thing in a development of a project.
- Example: Operational, market and financial

DIFFERENT FORMS OF TECHNICAL LITERATURE

 Abstract
- It is a brief summary of a research article, thesis, review, conference proceeding or
in-depth analysis of a particular subject or discipline, and is often used to help the
reader quickly ascertain the paper’s purpose.
 Treatise
 - It is formal and systematic written discourse of some subject,
generally longer and treating it in greater depth than an essay, and
more concerned with investigating or exposing the principles of the
subject.
 Proposal
- It is a document that describes the purpose of a project, the tasks that will be
performed in the project, the methods used to complete the project, and finally the
cost of the project.
 Brochure
- Is an informative paper document mainly used for advertising to introduce a
company or organization and inform about products and services to a target
audience.
 Pamphlets
- Is an unbound booklet (that is, without a hard cover or binding) usually used for
displaying a single item or subject.
 Memoranda
- A written proposal or reminder

TYPES OF TECHNICAL DOCUMENTS

User Guides

User guides help people use a particular system like a piece of hardware or software. They provide
clear and sensible information on common questions that users may face. User guides can also
contain information on possible malfunctions and ways to fix them. An example is an online help
for ClickHelp. It describes features, possibilities, and use cases of this software documentation tool.

Product Manuals
 Product manuals are created in order to describe basic operations of a product, its
main features, general maintenance, and more. Here is an example — a page from a
wristwatch manual:

API

Documentation

Technical writers create API documentation where they describe instructions about how to
effectively use hardware (SCPIs), web-API, or software API. Usually, API documentation contains
all the information required to work with the API, details about classes, functions, arguments, and
the like, supported by examples and tutorials.

API documentation aims to help clients or users implement API and understand how it works. This
type of documentation help businesses, for example, make it easier for users to interact with the
code.

Science Papers, Research, and Reports

Technical writers also work with professionals from other spheres like medicine, science,
aerospace, engineering, and so on.

Speaking of science and medicine, researchers write papers with the results of their work but those
results can be hard to explain to the broad audience, so authors ask tech writers to help them
interpret and organize findings. These are published in journals, and because of that accuracy and
content organization are very important — and tech writers are best for this job.

Technical writers also assist business owners to help them create reports because clarity and
accuracy of content are also required.

TECHNICAL MARKETING DOCUMENTATION

Image for post

 Technical writing includes marketing content as well. Tech writers can create easy-
to-interpret and concise articles which help clients understand how to properly
operate a product. White papers, case studies, proposals are the examples of technical
marketing documentation.

White Papers

The main goals of a white paper is to highlight a company’s success and help to promote the
products or services of a company. As a marketing tool, white papers collect information on facts
and logical arguments why this company and its product are the best. White papers usually focus on
new solutions to an old problem, or the benefits of a B2B product or service.

Case Study

A case study is an analysis of a company, product, or a project that identifies a solution or situation
that contributed to failure or success. Case studies allow potential buyers to see your product in
action. They focus on a customer’s experience to show how a particular product or a service can
help you and your business.

Proposals

Technical writers also create proposals for B2B companies. Technical writers help to persuade the
reader to approve a proposed project or implement a proposed plan. It may contain
recommendations, results of surveys, technical background, information about feasibility, and so
on.

End User Instructions

When you purchase a software program, install a computer peripheral, or buy a technological
gadget or consumer appliance, it comes with an electronic or hard copy user guide that
provide instructions on how to use it. Writers who create these kinds of documents must interpret
highly technical data, then present it in user-friendly language that can be understood by a general
audience. This category also includes troubleshooting guidelines, assembly instructions, lists of dos
and don'ts, warranty descriptions, and legal disclaimers.

Technical Reports
 In addition to instructions and guidelines, many technical products include
information on the product's history, evolution, or structural or operational revisions.
Technical writers organize the information and edit it for brevity and accuracy.

Feasibility Studies and Corporate Reports

Feasibility studies and corporate reports (such as annual financial reports) require precise research

and presentation of facts that can be easily comprehended by several levels of employees,
executives, and shareholders. These reports normally include graphs and charts for comparative
purposes in the areas of economics, timelines, and social or business practicality along with
narratives to explain the visual aids.

Research Results

Products such as pharmaceuticals or medical devices are accompanied by documentation of

findings and interpretations based on laboratory testing or field research. Exemplary attention to
detail is vital to the presentation of research results since this type of technical writing frequently
includes facts on drug interactions, side effects, and other important health-related concerns.

Policies and Procedures

Both large and small companies have policy and procedures guidelines to govern their organization
and employee handbooks to help protect themselves against lawsuits from employees who might
claim they weren't aware of certain rules and regulations. Technical writers present these
instructions in clear, non-discriminatory terms and understandable language.

Business Plans

Before lending institutions consider extending loans to new or established businesses, they require a
detailed business plan. These documents require highly technical financial and operational research.
They include projections on expenditures, possible losses, and profit margins along with a
competitive analysis, marketing strategies, and detailed background information on the professional
background and financial stability of the owner(s).

White Papers
 White papers are guides to making decisions and solving problems that are created
by an organization for an external audience. They explore specific problems,
presenting authoritative solutions that readers are encouraged to adopt. White papers
are used in many industries and business types to explain an issue and to recommend a particular
solution, product, technology, or methodology.

Case Studies

Case studies provide written analyses of real life situations. They can be about individuals, groups,
organizations, clinical practices, decisions, or events which reflect study of the subject over a
defined period. They attempt to identify patterns in data about the topic from which generalizations
can be made and trends can be identified. Case studies often appear in scientific journals, though
they also have their place in business and industry.

Literature Reviews

A literature review can be either a standalone document or included as part of a primary report. You
can think of literature reviews as technical writing that provides an overview of what is known on a
subject. They summarize and provide details about previously conducted research and findings on a
topic, emphasizing research milestones, conflicting results, and what remains to be discovered
through further research.

Proposals

Proposals are specifically written as a call to action to get an individual or a group to do something.
Real life examples include proposals to receive grants, do projects, purchase products, or consider
specific improvements to an organization, product, methodology, or service. Since a proposal must
be highly persuasive, it must be written with its intended audience uppermost in mind. The writer
must strive to identify the need at hand as well as describe (and convince readers to adopt) the
intended plan of action.
Application

1. A technical report is considered a long report that involves some research. This report
is used in all types of courses and in the majority of the time is considered a final
report. B
a. False, it does not involve research.
b. False
c. True
d. It depends
e. None of the alternatives mention
2. Elements to consider when planning your technical report: D
a. Topic- the subject you are going to write of.
b. Audience- the specific people in whom you are going to focus your topic.
c. Purpose- the specicific goal the report will accomplish.
d. Alternatives A and C
e. All the alterntives mention
3. Types of Technical reports: D
a. Technical background report, Technical Specifications, Primary Research report,
Business plans
b. Instructions, Feasibility, Recommendation and Evaluation reports, Report Length
Proposal
c. Conclusion, Essay, Bibliography, Summary, Resume
d. A and B
 4. “In _________ you discuss some new product design in terms of its
construction, materials, functions, features, operation and market
potential.” B
a. Instructions
b. Technical Specifications
c. Technical background report
d. Business plans
e. None of the alternatives mention
5. The following is/are the critical step in planning your report: D
a. Defining the plot and specific requirements
b. Defining the specific audience
c. Defining the specific situation
d. Alternatives A and B
e. Alternatives B and C
6. The report should use a specific format of headings required for the course. A
a. True
b. False, it does not need headings
c. False, it uses a general format of heading
d. None of the alternatives mention
7. You must state clearly your report purpose in the introduction. A
a. True
b. False
8. You must include an informative abstract in your report, which will act as another
introduction or descriptive abstract. A
a. True
b. False