TW Lesson 4 cont.

Organization

During the organization stage, a technical writer reviews all information gathered during the research phase divides it into sections, and creates a formal outline for the writing project. This includes dividing larger sections into a series of smaller sections, each clearly covering every necessary point. Technical writers divide the researched information throughout these sections, ensuring that every point has enough cited information to stand as an independent point, without repeating information in multiple sections.

sentence outline

In a ________ _______ , the thesis and topic sentence of each supporting paragraph is fully written out. The sentence outline forces part of the essay to be written out in sentences before the first draft.

Review and Revise

Once the technical writer finishes with the first draft, she enters the review and revises the stage, where she reads the draft and makes necessary changes. The technical writer checks for spelling, word choice, punctuation, passive voice usage, and typos in the original draft. After the changes are made, she returns to the review and revises the stage until the document is clear, precise, and accurate.

First Draft

Technical writers sketch out the first draft, often by writing each section separately and using the organized research for each section as they write. Draft writing, for technical projects, focuses on active language, specific word choices, a clear presentation style, and concise information for busy readers. Technical writers use obvious section titles, dividing information clearly for readers.

Research

The research stage is the phase in which the technical writer gathers information about the project. This includes interviewing people working on the project, reading technical information about the project, and spending some hands-on time working with the new project if this is possible. Technical writers can return to this stage multiple times if their initial information is not sufficient to cover the necessary project information.

Writing Plan

an outline helps writers create a writing plan. Writers can test which ideas work well together and which examples best support their topics. With an outline, writers can move information around, see gaps in logic, and experiment before committing to a full draft. Outlines enable writers to visualize whether they have included enough information for an introduction, body, and conclusion.

Collaborating

collaboration is common in technical writing because no particular person has all the information, skills, and time to create a large document. Writing with a partner often occurs when two people report research or laboratory tests they have jointly conducted.

Development

develop your paragraphs by including enough details so that your reader understands the main point.

Writing Clearly

each paragraph in a document is a unit of sentences that focuses on one idea as a visual element to break up the text into manageable chunks of information. Writing clearly guides readers by: a. Introducing individually distinct but related topics b. Emphasizing key points c. Showing relationships between major points d. Providing visual breaks in pages to ease reading.

Preparation

is the earliest stage in the technical writing process. During the preparation stage, a technical writer answers a series of questions regarding his project. These include considerations about the skill level of the audience, which determines the technical specificity of the final document, and the purpose of the piece, which explains the direction in which the writer will direct the project. The scope of the project considers the amount of material the project should cover, and the medium used to present the information considers the specific format used, such as the internet, a PowerPoint presentation, or a formal document.

Unity

means concentration in one single topic.

topic outline

provides a quick overview of topics to be included in an essay. You are probably already familiar with this structure. Look at a syllabus from one of your courses. It is probably the equivalent of a topic outline, with topics listed for each unit, and readings and assignments under each. After each heading in a topic outline for an essay, a maximum of several words is used to identify the topic or idea that will be discussed under the given heading.

Stay Organized

the content organization can be challenging when writers generate pages of text and then try to impose order. More often than not, the paper will be marked by repetition and include irrelevant content. This is where an outline can save the day. With the thesis, topics, and sub-topics already in place, the writer does not have to stop the flow of writing. She can just use the outline as a template and expand with details.

Informal and Formal Outlines

to create a list outline, start with a thesis, and list ideas. For a basic scratch outline, start with a thesis, number your topic sentences, and include answers to questions the paper will answer. In topic outline, begin with a thesis, and then using short phrases, assign Roman numerals to topics and letters to subtopics. A formal, sentence outline, organized like a topic outline, is most useful for long, complex papers.

Coherence

when sentences proceed in a sequence that supports one point at a time.

Stay on Track

with an outline, writers have already laid out how they will proceed with writing their paper, which prevents meandering aimlessly on the page and confusing readers. With most of the heavy lifting done, writers need only to refer to their outline to keep their writing on track. Outlines are especially helpful when writing longer papers, where forgetting important points and sources are more likely. An outline is a detailed roadmap.

Organizing Content

• Researching Information - the organization of a document has a strong influence on how well the reader understands and is able to use the information; as a technical writer, you must organize information to help readers learn and remember it. • Select major topics - begin organizing your document by sorting information into major topics; select the topics based on your analysis of your reader's interest and need for information. • Identify subtopics - after you determine your major topics, consider how to sort the information into appropriate subtopics. • Structuring Information - an outline begins as a short, informal list of topics and grows into a detailed list that includes all major topics and subtopics; it is later grouped into chunks of information most appropriate for the reader.