Академический Документы
Профессиональный Документы
Культура Документы
3. Comprehensiveness
4. Accessibility
5. Conciseness
6. Correctness
1. Clarity
Technical document must convey a single meaning that the reader can
understand. Unclear Technical writing is expensive. They vital communication link
among the various employees is usually the report, if this link is weak, the entire
project may be jeopardized. Unclear technical writing can be dangerous e.g.
unclear instruction on how to operate machinery.
2. Accuracy
Unclear writing can cause many problems and even inaccuracy in the report. If you
mean to write 40,000 dont write 400,000. If you mean to refer to fig 3.1 dont refer to
fig 3.2. Slightest error can confuse or even annoy the reader of the report. If the reader
suspects that you are slanting information they have the right to doubt the entire
document.
3. Comprehensiveness:
When writing technically, all the information should be provided, its background must be
described and clear description of any process, or method of carrying out a specific
work, should also be given. It also includes results, conclusions and recommendations.
4. Accessibility:
It means the ease with which the readers can locate the information they seek.
To increase Accessibility, include headings and lists in the report. A table of contents, list
of illustrations glossary and index are preferred.
5. Conciseness:
Technical writing is meant to be useful. The longer a document is, the more difficult it
gets to use it. Even it takes more of the user's time.
Conciseness works against clarity and comprehensiveness. Solution to this conflict is to
create a balance between the requirements of clarity, conciseness and
comprehensiveness. In short, in T.W every aspect of the subject is discussed in optimized
detail. Document must be long enough to be clear. It must give the audience purpose
and object but no extra details. Technical writing can be shortened 10-20% by
eliminating unnecessary phrases and choosing short words and sentences.
6. Correctness
Qualities of technical report writing also include correctness. Good technical report
must also be correct. It must be free from grammatical errors, punctuation mistakes, and
should have appropriate format standard. If a report contains grammatical errors, the
reader will doubt the accuracy of the information in the report. Technical writing is meant
to convey information and to persuade the audience. To accomplish these goals it must
be clear accurate, easy to access and must be economical and correct.
Project Proposals in Technical Writing
A document which persuades its readers to accept the writer's idea is called a proposal.
The Project Head asks for both a technical proposal and a cost proposal.
There are two kinds of proposals.
1.
External Proposal
2.
Internal proposal
A. External Proposal:
In external proposal, one firm responds to a request from another firm or the
government for a solution to a problem. It ranges from lengthy (100 pages or more) to a
short (4-5 pages).
A firm writes external proposals to win contracts for work. Government agencies and
large and small corporations issue a request for proposal which explains the project and
lists its specifications. Companies which receive the writes proposals. A team assembles
a document that shows that the company has the managerial expertise, technical
knowhow and appropriate budget to develop the project.
After receiving all the proposals, the firm that requested them turns them over to a team
of evaluators, who after judging the technical management and cost sections, select the
best proposal.
Planning the External proposal
To write an external proposal, you must consider your audience, research the situation,
use visual aids, and follow the usual form of this type of document.
1. Consider the audience:
Usually your audience express problem to you in a written statement (an RFP) or in an
interview. You must assess their technical awareness and write accordingly. To write to
them effectively, one should
1. address each need that they have expressed
2. explain in clear terms how your proposal fills their needs
3. Explain the relevance of technical data.
2. Research the situation:
To write the proposal effectively you must clearly understand your customers needs as
well as your own service. You must research their needs by means of interviewing them
or by reading their printed material.
3. Use visual aids:
Many types of visual aids e.g table, maps etc may be appropriate to your proposal. Your
goal is to convince the decision makers that only your way is the best approach; good
visuals are direct and dramatic, drawing your client into the document.
To write an external proposal, follow the usual form for writing the proposals. The four
main parts of a proposal are:
a. Executive summary:
The executive summary contains information designed to convince executives that the
proposers should receive the contract. It should present the content of technical,
managerial and financial sections in clear terms. This section is often designed to make
non technical people feel comfortable with the proposal.
What is a Report?
In academia there is some overlap between reports and essays, and the two words are
sometimes used interchangeably, but reports are more likely to be needed for business,
scientific and technical subjects, and in the workplace.
Whereas an essay presents arguments and reasoning, a report concentrates on facts.
Essentially, a report is a short, sharp, concise document which is written for a
particular purpose and audience. It generally sets out and analyses a situation
or problem, often making recommendations for future action. It is a factual
paper, and needs to be clear and well-structured.
Reports may contain some or all of the following elements:
Conclusions.
When writing the text of the report, it is necessary to acknowledge and cite
the source in the text. The details of this source is presented in the notes
section at the end of the text of the report. A bibliography is a list of sources
consulted when preparing the report.
A Word on Writing Style
When writing a report, your aim should be to be absolutely clear. Above all, it
should be easy to read and understand, even to someone with little knowledge
of the subject area.
You should therefore aim for crisp, precise text, using plain English, and shorter words
rather than longer, with short sentences.
You should also avoid jargon. If you have to use specialist language, you should
explain each word as you use it. If you find that youve had to explain more than about
five words, youre probably using too much jargon, and need to replace some of it with
simpler words.
Consider your audience. If the report is designed to be written for a particular person,
check whether you should be writing it to you or perhaps in the third person to a job
role: The Chief Executive may like to consider, or The minister is recommended to
agree, for example.
Different types of Reports
Reports assist in decision making and problem solving by conveying information
objectively. Reports are classified in numerous ways. The form, direction, functional area
and content of the report are used as the basis for classification. Reports may be:1. Formal or Informal Reports
(a) Formal Reports are carefully structured; they lay stress or objectivity and
organization and contain much detail.
(b)Informal Reports are usually short messages with natural, casual use of
language.
2. Short or Long Report: Depends on the length of the Reports.
3. Informational or Analytical Reports:
(a) Informational reports (like annual reports etc) carry objective information
from one area of organization to another.
(b)Analytical Reports like feasibility reports or scientific research present
attempts to solve problems.
4. Proposal Reports:
the report. In some organizations the title page is preceded by a title fly. The title fly is
a plain sheet of paper with only the title on it. It adds a touch of formality to the report.
Usual elements are
Title
Name and position of writer
Name and position of principle reader
Date of submission
A good title must be informative. It. answers two basic questions
1. What is the subject of the report
2. What type of report is it?
Define the type of report by using a generic term such as analysis, recommendations e.g
summary, review etc. For a simple title page, centre the title (typed in full capital letter)
about a third of the way down the page, then add the readers and writer's position, the
organizations name and date.
3. The abstract
Its like a brief technical summary, usually not more than 200 words of the report. Its
directed to readers who are familiar with the technical subject and need to know
whether to read the full report or not. This can use technical terminology and refer to
advanced concepts. Basic types of abstract are descriptive and informative
abstracts. The descriptive abstract sometime called topical or table of contents
abstract. It does not provide the import results, conclusion or recommendations. It lists
the topic covered giving equal coverage to each. The informative abstract states the
problems the scope and methods, and the major results, conclusion or
recommendations.
4. The table of contents
It enables different readers to turn to specific pages to find the information they want.
Well organized report becomes ineffective if table of contents, is not clear. T.O.C provide
only guide to report's structure, coverage and pagination. The headings that appear in
the report are listed in T.O.C
For effective T.O.C make sure the report has effective headings.
5. The list of illustrations
It is a T.O.C for the figures and tables of a report. If the report contains figures but not
tables, it is called the list of figures
But if the report contains tables but not figures so is called the list of tables only
List of illustrations may be on the same page as the table of contents, or may be on the
separate page. If it begins on a separate page, it should be listed in the table of
contents.
6. The executive summary
Sometimes called executive overview or the management summary. It is a one page
condensation of a report. Managers dont need a detailed and deep understanding of
various projects undertaken in their organization because of limitations in time and
specialization. The background of the project is also discussed clearly herein. The
specific problem that is to be solved through the project is clearly discussed; also the
conclusion and recommendations are discussed in a full separate paragraph.
Presenting another's ideas as if they are your own either directly or indirectly
Copying or pasting text and images without saying where they came from
Academic Referencing
There are numerous ways to reference. Different institutions, departments or
lecturers may require different styles.
give the original author credit for their own ideas and work
prove to your tutors/lecturers that you have read around the subject
avoid plagiarism
Referencing Styles
There are many styles of referencing; one of the most popular (in UK institutions) is the
Harvard system.
Be Organised
When writing an essay, report, dissertation or other piece of academic work
the key to referencing is organisation, keep notes of the books and journal
articles you have read, the websites you have visited as part of your research
process.
What needs to be recorded?
Record as much information as possible in references to make finding the original work
simple.
Author/s Include the author/s name/s where possible. You should write the surname
(last name) first followed by any initials. If there are more than three authors then you
can cite the first author and use the abbreviation 'et al', meaning 'and all'.
Examples:
For one, two or three authors:
Jones A, Davies B, Jenkins C
For more than three authors
Jones A et al.
For some sources, especially websites, the name of the author may not be known. In
such cases either uses the organisation name or the title of the document or webpage.
Example: Skills You Need or What Are Interpersonal Skills.
Date of Publication - You should include the year of publication or a more specific date
if appropriate, for journal or newspaper articles/stories. For web pages look for the when
the page was last updated. Include dates in brackets (2012) after author information. If
no date can be established then put (no date).
Publisher Information - Usually only relevant for books, you should include the
publisher name and place of publication.
Title of Piece - Include the title of the piece; this could be the name of the book, the
title of a journal article or webpage. Titles are usually written in italics. For books you
should also include the edition (if not the first) to make finding information easier. Often
when books are republished information remains broadly the same but may be
reordered, therefore page numbers may change between editions.
Page Numbers - If you are referencing a particular part of a book then you should
include the page number/s you have used in your work. Use p. 123 to indicate page 123
or pp. 123-125 to indicate multiple pages.
URL and Date Accessed - For web pages you need to include the full URL of the page
(http://www... etc.) and the date you last accessed the page. The web is not static and
web pages can be changed/updated/removed at any time, it is therefore important to
record when you found the information you are referencing.
Once you have recorded the information, you have everything you need in
order to reference correctly. Your work should be both referenced in the text
and include a reference list or bibliography at the end, the in text reference is
an abbreviated version of the full reference in your reference list.
Citation and Reference
Citation and reference are two important terms used in research methodology, the
difference between these two terms have to be understood clearly. Citation is a
reference to a published or unpublished source. It is generally an abbreviated
alphanumeric expression found in the pages of a thesis or a dissertation. The primary
motive of citation is to exhibit your intellectual honesty. On the other hand, reference
consists of the act of referring. Reference appears at the bottom of a page as
a footnote as well as a list at the end of the thesis or the paper you are writing.
A citation is how you quote the source of the ideas within the body of the research paper.
Citation is included at the places wherever you quote from different authors. Normally,
you put the citation at the end of the sentence within brackets. Inside this bracket, the
authors name, year the book was published or the page in which this particular
extraction appeared are included. What exactly comes inside this bracket is a decision
made by the format you follow in writing the paper. Different formats have different
styles for citation. You can see that from the following examples.
APA Her blood warmed the earth (Martin, 2014).
MLA Her blood warmed the earth (Martin 263).
The very purpose of citation lies in the fact that you are wilfully acknowledging the writer
of the work from whom you have borrowed a quotation.
Reference consists of the act of referring. As a researcher, you refer to some books and
journals while writing the thesis or dissertation. As a matter of fact, you would include
some references in the pages of your thesis in the form of footnotes. The footnotes
contain the reference passages taken from the relevant books and journals from which
you quote them. At the end of each chapter, you would give the corresponding books
and journals from which you have picked the quotations mentioned in the footnotes.
These are references. However, you do not have footnotes in APA style. You only have a
list called References at the end. Also, when it comes to the end list that gives
references, there are small changes between those lists in different styles too. This list of
reference is normally known as the Bibliography. In APA, this list is known, as mentioned
earlier, as References. In MLA, the list is named Works Cited. Also, APA reference list
only contains the sources you have actually cited in the text. In other lists of reference,
normally the sources that were only consulted are also included.
Usually, references are included at the end of the thesis. The purpose of
reference is only to let the reader of the thesis know the various books from
which you have quoted, from the list at the end or footnotes.
Thesis vs Dissertation
The two terms, namely, dissertation and thesis are not interchangeable as there is a
difference between them. In the academic sense, a thesis is submitted at the end of
a Ph.D. whereas a dissertation is submitted at the end of the Masters degree.
A thesis is a proposition that is maintained by argument, and it is put forward as a
premise to be maintained or proved. You are expected to contribute new findings
through research before you submit a thesis.
You have to ensure that you submit what is called a hypothesis or a synopsis before
submitting the thesis to get your Doctorate. The hypothesis or the synopsis should
contain the gist of the new findings you have made in the subject of your research. The
thesis should contain all details about the research you have made on the subject. A
thesis is given more recognition and considered higher in comparison to a dissertation.
A dissertation is a treatise advancing a new point of view resulting from research, often
based on original research. Its allowed to summarize your thoughts too. In a
dissertation, you have to synthesize and analyze the information collected by you. In
fact, you are allowed to summarize your thoughts.
A dissertation gives you a lesser degree than what a thesis gives. The degree qualified
by the submission of a dissertation should be followed by the degree qualified by the
submission of a thesis.
Hypothesis
Everything has an underlying cause and people have been attempting to explain those
causes ever since the curiosity has started to arisen in mans mind. In scientific method,
explanations were based on theories that came up from hypotheses. Accepted
hypothesis becomes a theory but rejected hypothesis will never get that status.
Therefore, it could be envisaged that hypothesis and theory are two stages of the
scientific method. The extent of scientific presence is variable between a hypothesis and
a theory.
According to the definitions by various dictionaries, hypothesis could be described as a
scientific explanation that has been suggested to explain a certain phenomenon.
Hypothesis gives the explanation as a proposal, and the scientific method tests its
validity using a procedure. According to the scientific method, hypothesis could be
repeatedly tested for its validity. The solution of the identified problem is described using
the hypothesis. A hypothesis is an educated guess, as it explains the phenomenon based
on evidence. The evidence of a phenomenon or the results of an experiment are used for
the explanation, but those were conjectured already through the hypothesis.