TC - Notes - 2
TC - Notes - 2
Note Making
Schedule 30 minutes to 1 hour for reading when you have much free time and the highest focus.
Find a place where you can get away from your phone, your family, and any other distractions
and just read. The idea is to create a place where you can focus and enjoy what you’re doing so
you can absorb what you’re reading because you need to keep focused, stay productive.
In the century of efficiency, we are trying to absorb the information as soon as possible. But
reading demands time. All it benefits are not seen immediately. Usually, after you’ve read the
big part of the book. Speed reading does not work.
d) Read in stages
Start by reading the title of the manual, the preface and then study the table of contents. Then
start reading parts of the sections that you discovered are most relevant to you.
Understand the content of the book. Don’t clarify everything. Make a note and move forward.
SQ3R Technique for comprehending technical manuals
The SQ3R technique is a five-step method designed to enhance reading comprehension and improve information
retention. The acronym stands for Survey, Question, Read, Recite, and Review. By following these steps, readers
can actively engage with the text, making the reading process more focused and effective.
Here's a breakdown of each step:
1. Survey:
Before diving into the text, skim it to get an overview of the material. Look at the title, headings, subheadings,
and any visuals like pictures, graphs, tables, charts etc. to see how they support and explain the text. This initial
survey helps you understand the main topics and structure of the reading.
2. Question:
Turn the headings and subheadings into questions. This transforms passive reading into active inquiry, prompting
you to seek answers as you read.
3. Read:
Read the text carefully, focusing on finding the answers to the questions you formulated in the previous step. Pay
close attention to the main ideas and supporting details. Note down essential points and vocabulary. Think,
interpret and analyze the first time you read, to avoid unnecessary re-reading.
4. Recite:
After reading each section, pause and try to recall the main points and answers to your questions without looking
at the text. Summarize the information in your own words, either mentally or by taking brief notes.
5. Review:
Once you've finished reading, review the entire text and your notes. Test your understanding by answering the
questions you created earlier and summarizing the key concepts. This step helps solidify your memory and
identify any areas that need further review.
By systematically working through these five steps, SQ3R helps readers become more active and engaged
learners, leading to better comprehension and retention of information.
Increasing your daily reading load will greatly help you in interpreting ay text. As it broadens
your textual analysis drills. And when we talk about “reading” we are referring not only to books
but also to other productions, such as news reports, blog posts etc.
Try to slow down the text by breaking it down into smaller parts so you do not have to interpret
everything at once in the end. Break down complex paragraphs into smaller, manageable
chunks.
c) Study grammar:
While reading, always try to have a dictionary around. Each time you notice a word that you do
not know the meaning, note or search. This will help you not miss any important term within the
text.
While reading any reading any technical text focus on the key terms and words so that it can help
you a lot with the learning of the subjects.
Summarization
a. The very first step for making a summary is to have a reading skill.
b. Underline or mark the main sentence of the passage.
c. After collecting the main points, check for the appropriateness of the ideas for making the
summary.
d. Prepare the first draft of the summary. You can add or edit any piece of information.
Purposes of Summarization
A summary is meant to inform the reader, who has not read the text or seen the presentation,
about what the text is about. It outlines its central idea and briefly describes the supporting
arguments that develop the idea. The reader then comes to know if the text is useful for him/her
and whether it should be read further or not.
• To know the essence of the report or article without reading the entire document.
• To establish the relevance of the report or article
• To get an overview before going through the details.
• To help them keep up with current developments in the field.
• To decide whether to read the article or not.
Techniques of summarization:
a) Selection:
For making a summary it is very important to select the main idea, keywords and the special
terms in the source. They help in getting the idea and making the summary.
b) Rejection:
It is a process of removing unwanted and not so important sentences.
c) Substitution:
It is a process in which new sentences get to add up instead of the previous one. Also, several
sentences are combined to form one sentence. It reduces the length of the summary.
Paraphrasing refers to the process of rewriting passage or text in different words without
changing or distorting its original meaning.
Note making:
Note making is an organized form of important points which can be used in future.
Divide your page into columns and rows, creating a grid-like structure.
2. Identify Categories:
Determine the relevant categories or topics that will be the headings for your columns.
As you encounter information, record it in the appropriate column and row, summarizing key points and details.
The structured format allows for easy comparison of information across different categories and topics.
When to Use the Charting Method:
When you need to analyze similarities and differences between different concepts, products, or ideas.
Organizing Data:
When dealing with numerical data, statistics, or other information that can be organized into categories.
How it works:
1. Central Topic:
Identify the main topic or idea and place it in the center of your page or digital document.
2. Branching Out:
Create branches extending from the central topic for main subtopics or key ideas.
3. Further Subdivisions:
Branch out further from the subtopics to include supporting details, examples, and related concepts.
4. Visual Elements:
Use colors, symbols, images, and different shapes to highlight connections and make the map visually
engaging and easier to understand.
Technical Documents
What Is Technical Documentation?
Technical documentation includes notes, templates, standards, rules, and any other guides with
information about a product’s or process’s features and functions. Often used in the software
development industry, this type of documentation is sometimes known as a technical or instruction
manual, but it can go beyond simple instructions.
Technical documentation serves various purposes. For example, it can take the form of step-by-step or
troubleshooting guides for customers, instructions for installing software for end-users, guidelines for
developers performing technical processes such as debugging, or technical reference documents for
engineers that include specifications, diagrams, and procedures.
There are numerous types of technical documents hence, it becomes imperative to group them into
three main categories:
End-User Documents
End-user documents are used for electronics and other consumer products. The goal of end-user
documents is to help a novice in understanding how to use technical items. User manuals for computer
(hardware and software), televisions, mobile phones, washing machines, air conditioners, and other
consumer electronic items are examples of end-user documentation. Patient information booklets and
product inserts for in-home medical devices, such as pregnancy test or diabetic glucometer, are also
end-user documents. While writing the document, the writer must contemplate about the problems that
the users might face and accordingly explain and give the solutions. The end-user documentation
writer may or may not be the technical expert.
Information/Data Collection
Information collection constitutes the first step in a statistical investigation. Utmost care must be taken
in collecting information because it forms the foundation of statistical method. Information collection
methods can be divided into two categories:
Personal Interview
In this, the interviewer asks questions face to face. Through this methodmore and reliable information
may be obtained. Private and confidential information can be obtained comfortably under this method.
It is, however, a costly and time consuming method especially when a widely spread geographical
sample is surveyed. Some respondents who enjoy high social status such as officials, executives, etc.
may not be easily available. In this method, the respondents may give wrong and imaginary
information. For an effective interview, there should be a good rapport with respondents which is
often very difficult to develop. The interviewer should be friendly, courteous, conversational and
unbiased for which proper training is required.
Telephonic Interview
Contact is made with the respondents through telephone. The merits of telephonic interview are:
(i) It is more flexible and faster than other methods.
(ii) (ii) It is cheaper and less time consuming because no staff is required and a wider
representation of the sample is possible.
(iii) (iii) Answers of the respondents can be recorded for deliberating on them later on.
This method has several disadvantages as well. These surveys are restrictedto respondents who have
telephonic facilities and little time is given to respondents for answers. Hence, it is not suitable for
intensive surveys where comprehensive answers are required for various questions.
Document design
Document design concerns about the physical appearance of the document. Readers do not read only
the printed words on a page, but the visual presentation of the text also impresses them and enhances
their understanding. Furthermore, a good document should effectively communicate as well as
translate the main ideas to the audience.
In the documentation, the design phase should decide upon the following:
• What will the document cover?
• What format will the document take?
• How will the document look?
• In what order will information be presented?
The design stage must consider the requirements of the audience, in order to create something suitable
for their task. While designing, technical writers should take care of five goals to be fulfilled by the
document.
1. The document must look professional and create a positive image of the product and the company.
2. The document must be easily navigable and follow a logical and reasonable order.
3. The document must give the readers the information they need. It should be designed in such a way
that finding the information is easy.
4. The document must convey the message clearly and accurately.
5. Well-designed documents must make the information easy to remember. It can be done by using
visual aids.
Factors Affecting Document Design
Effective document design is influenced by several key factors that affect how readers perceive and
interact with the content. There are six important factors that should be considered while designing a
document.
1. White Space
White space can be defined as a clear area on a page which has no text or graphics. White space is an
essential factor in document design as it helps the reader to process and digest the text easily. In case
of complicated data with lots of detail, white space guides your eye to focus on the important
information. Hence, white space should appear in margins, headings, columns, as well as indentations.
2. Written Cues
The importance of written cues is to help the readers to find specific information quickly. These cues
can be provided through the use of headings, headers and footers, jump lines, icons, as well as logos.
They help to provide an overview which makes the reader skim the document quickly and easily.
Additionally, these cues also divide the document into different segments regarding the different sets
of information presented within the document.
3. Graphic Aid
There is a famous quote ‘a picture is worth a thousand words’. The use of graphics in document
design provides a simple visual aid which summarizes complex information such as complicated
numerical data. Graphic aids have many forms like tables, graphs, diagrams and pictures. The graphic
aids offer readers a quick, simplified explanation which also saves up the document space.
4. Balance
The term ‘balance’ in document design refers to having an equal visual appeal on a page. It is
essential to take this factor into account as it influences the overall appearance of the document.
Distributing visual elements evenly across the page helps create a sense of harmony and avoids a
cluttered appearance.
Important aspects which are instrumental in keeping the balance:
Colour
Contrast
Alignment
5. Proportion
Proportion is about the size and placement of text, graphic aid, as well as format elements within a
document layout. You should avoid using monotonous layout throughout every page of your
document because it would interfere with the reader’s ability to use the document.
6. Consistency
The final factor that is needed to be considered in document design isconsistency. Consistency is
about maintaining similar features in similar styles, page after page. Consistency helps readers to
emphasize on similar types of information and their importance. There are three most important
elements to consider in keeping a well-balanced consistency of the document. They are margins,
typeface and indentations.
Online Media
Scannable Content: Online readers often scan content, so writing needs to be concise and
easily digestible.
Short-Form Content: Online articles are typically shorter and more to the point.
Interactive Features: Online media allows for comments, sharing, and other interactive
elements.
Instant Updates: Online content can be updated in real-time, providing timely news and
information.
Global Reach: Online content can reach a global audience with ease.
More Conversational Tone: Online writing often adopts a more casual and conversational
tone.
Shorter Paragraphs and Sentences: Online writing uses shorter paragraphs and sentences to
improve readability.
The differences in writing style for print and online media can be summed up in the following
points:
Print publications contain linear content that is often consumed in a relaxed setting and
manner. The linear narrative in print can be further spiced up with anecdotes and individual
examples that support a story telling approach. However, the web rewards comprehensive
coverage that’s more specific than print content.
Web content must be brief and to the point because it is more likely that users are looking for a
particular thing. In many cases, they pull up the page through search. Web users want
actionable content; they don’t want to waste their time on stories that are divergent to their
current goals.
Print is an author-driven narrative, while web content is a user-drivennarrative. Instead of a
predefined narrative, websites condense and combine information into something that
purposely meets the users’ requirements.
Print writing requires well-crafted, complete sentences. However, writing incase of online
media is replete with fragmented sentences which often let he users pull information-carrying
keywords to the front. Web users read only 18% of the written words hence, cutting down
words is a practical approach to online writing.
In print media or linear media which includes television as well, peopleexpect the writer to
construct his/her experience for them, while in online media or nonlinear hypertext, the users
want to construct their own experience by collecting content from multiple sources manifesting
their desires at that moment.
It is undeniable that the web is too quick for intensive learning. It is idealfor narrow, last-minute
learning of information fragments but this is subject to the condition that the learner already has the
conceptual framework in place to make sense of the facts
Important Questions
1. Discuss different steps in the reading of a technical text?
2. Explain the definition and purpose of a summary?
3. What are the different types of summary? Discuss.
4. Explain the different methods of note making?
5. What is information design? How designing for digital and print media depart from each other.
6. What are the differences in writing style for print and online media?
7. What is the importance of organizing information? Explain the different strategies for
organizing information?
Technical Writing
No writing can be done without a specific purpose!
Technical writing involves more than just putting information into a document that can be understood
and applied by the target audience. The process of writing takes shape according to the need/context
of the target audience. As a technical writer, the first thing is to decide the area of your focus. The
writer should possess sufficient working knowledge that enables him/her to transfer his/her ideas in
simple terms that can be understood easily by the prospective readers.
Difference between Technical Writing and Creative Writing:
Creative Writing Technical Writing
It is persuasive, narrative and descriptive in nature. It is direct, objective, precise and clearly
1
Sentence framed are indirect, unclear and complex. defined. Sentence framed is simple and direct.
Figurative language is used that lays an emotional Figurative language is not used in technical
2
impact on the readers. It is often subjective in nature. writing and hence doesn’t lay an emotional
impact on the readers.
Creative writing involves artistic imagination. The tone Visual aids like graphs, charts, diagrams,
3
can be serious, satirical, casual or funny illustrations, tables, etc are used to make the
content easy to understand.
Plays, poetry, story, action, etc. are the examples of Research articles/publications, reports, note-
4
creative writing. sheets, minutes of meeting, etc. are the
examples of technical writing.
10/26/20 sonia 1
1. Prewriting/Planning
The key to a great writing is in the planning. Before you sit down to write something, you need to
figure out what you are going to write about. Everything needs to be planned, ‘If you fail to plan, you
plan to fail.’
This initial stage involves brainstorming, researching, and planning. Writers explore ideas, gather
information, and outline the structure of their writing. It is the backbone of a document/writing. It also
includes time spent researching as strong research provides the raw materials necessary to "build" an
effective written document. While planning usually occurs early in the writing process, writers return
to these planning strategies many times throughout the writing process.
2. Draft
Drafting is the writer’s first attempt to capture ideas on paper. The goal is to create a rough version of
the content, building upon the ideas developed during the prewriting stage. During the drafting stage
you should concentrate on organising your information logically, and developing your topic with
enough detail for your audience and purpose.
3. Revising
Revising literally means to “re-see” or “re-look” at your writing. It is at the heart of the writing
process.
If drafting is for the writer, revision is for the reader. During revision writers consider their writing
from your audience’s point of you. Here a writer revisits, reshapes, and re-views the writing many,
many times. Parts are added, moved around, or taken away.
At this stage most writers and find it helpful to have someone else read their writing. A reader who is
unfamiliar with your document can help you identify which parts are working and which parts are still
unclear.
4. Editing
While revising focuses mainly on making your content clear for your readers, editing focuses on
making your documents meet the conventions of standard written English. Editing focuses on
correcting errors in:
a. Grammar
b. Sentence structure
c. Word choice
d. Spellings
e. Punctuation
f. Capitalization
g. Citation and document format
This stage ensures the writing is polished and error-free. Editing enhances the readability and
professionalism of the written piece.
5. Publishing
Writing is communication- if you have written something, you must have intended for someone to
read it, even if that person is only yourself. Sharing writing with real people is what makes it become
real and come alive. It also helps the writer develop a sense of audience and voice.
When you publish a document, you are releasing it to the public for others to read. Not all of your
writing will be taken through the publishing stage, but even turning a paper in to your teacher
constitutes “publishing.”
Discourse is an extensive term used in reference to spoken and written language that is used in many different
personal, social and technical contexts. Discourse can vary according to the target audience and purpose of speech
or writing. The writer tries to communicate with the readers using literary devices and compositional techniques
(rhetoric).
The most common modes of rhetoric are narration, description, persuasion, argumentation, exposition and the
purpose for writing.
1. Narration
Narrative writing tells a story by describing events. It often employsdescriptive writing to help fashion a scene.
The purpose of this rhetorical mode is to show the reader what happened and how.
b. Characters
c. Setting
d. Plot
2. Description
It often depicts a person, place or thing with great illustrative detail. Italso features descriptive words/phrases and
sensory images. The five Ws (who, what, when, where and why) must be kept in mind for a lively
and precise description. Descriptive techniques are used in:
a. Journal entries
b. Poems and fiction
c. Biography
3. Persuasion
The purpose of persuasive discourse is to convince the readers/listeners to change their mode of thinking or to
persuade them to take a specific action. Persuasion often appeals to emotion. Persuasive techniques are often used
in:
a. Advertisements
b. Political campaigns
4. Argumentation
Argumentative discourse is similar to persuasive discourse. However, the arguments should be logical and be
supported by facts. Persuasive techniques are often used in an argument.
5. Exposition
This style of writing attempts to explain, inform or analyze an idea or concept so that the reader knows exactly
what the writer means. Its purpose is to convey information about an issue, subject, method or an idea. Exposition
techniques are often used in:
Exposition techniques are often used in:
a. History books
b. Biographies
c. Autobiographies
d. Some novels
Common Errors
Writing and speaking in English as a non-native speaker has its own set of glitches and difficulties.
Grammatical errors can easily confuse and obscure meaning. Generally, we find the common errors
with prepositions, tenses, subject-verb agreement, punctuation or spellings, etc.
Comprehension of Technical Materials/Texts and Information Design & development- Reading of technical texts, Reading
and comprehending instructions and technical manuals, Interpreting and summarizing technical texts, Notemaking.
Introduction of different kinds of technical documents, Information collection, factors affecting information and document
design, Strategies for organization, Information design and writing for print and online media