DSST Technical writting notes 1

Technical document the best place to include a

Info iconThis preview shows pages 1–3. Sign up to view the full content.

View Full Document Right Arrow Icon
Technical Document - The best place to include a definition depends on the flow of the document. Definitions are necessary for reader understanding, but they should not impede the document's flow. Parenthetical definitions are appropriate if there are only a few on each page, but more terms might require a glossary or an appendix. Letters that convey a negative message should be organized in a "good news-bad news" format. Begin a refusal letter with a buffer that shows appreciation to the recipient. Anticipated reader reaction to a memo primarily determines the choice of organizational pattern. The direct pattern in a memo places the main point in the first paragraph; this pattern is most commonly used when relaying positive or routine information. Sales Proposal - Cost analysis and site preparation are components that would appear in the body of a proposal Technical Writing - Negative definition, definition by cause, and definition by analogy are methods of expanding definitions in a technical document. Expanded definitions range from a paragraph to several pages. Formal Report - Both prefaces and forewords are optional introductory statements included in formal reports; however, someone other than the author writes the foreword Instructional documents appear in many different formats, including reference cards, instructional brochures, manuals, and online documentation.
Background image of page 1

Info iconThis preview has intentionally blurred sections. Sign up to view the full version.

View Full Document Right Arrow Icon
Definitions placed within the text interrupt the flow of the document because readers cannot avoid seeing them. Placing a definition in the margin, in a footnote, or in a hypertext document allows readers to skip the definition if they already understand the term Both manuals and reference cards are formats used to convey instructions, but manuals are lengthy and include warnings and troubleshooting advice. For a simple software update, a brief reference card that lists the installation steps would be most appropriate. Firms request feasibility reports when they are considering new projects or major changes and need to determine the likelihood of success. The chronological order pattern, which follows a sequence of steps, is almost always used with instructions. The conclusion of a progress report should evaluate whether a project is proceeding well or poorly and summarize the project's overall status. The topic sentence of a paragraph guides the direction of a paragraph and forecasts the topic of the paragraph to the reader. Tables, pictographs, and pie charts are commonly used in technical documents to illustrate numerical information. Feasibility reports include the specific recommendations of the author as well as enough details to support the recommendations. The conclusion of a feasibility report explains possible options and suggests which one is most appropriate. Most justification memos begin with a brief introduction that explains a problem and a recommendation for
Background image of page 2
Image of page 3
This is the end of the preview. Sign up to access the rest of the document.

{[ snackBarMessage ]}

Page1 / 5

Technical Document The best place to include a definition...

This preview shows document pages 1 - 3. Sign up to view the full document.

View Full Document Right Arrow Icon
Ask a homework question - tutors are online