technical report

• TECHNICAL WRITING - a specialized form of content creation that involves explaining complex concepts, processes, or products to a specific audience.
• ➤ The purpose of technical writing is to convey complex or specialized information in a clear and understandable manner to a specific audience. 
• This could involve providing instructions, explanations, descriptions, or other types of information content related to a technical subject.
• Technical writing - use to inform, instruct, direct, a specific audience through maximum clarity and precision with a specific tangible goal in mind
• On rare occasions, technical writing is used to persuade, the persuasion is indirect through informing, instructing, and directing
• TECHNICAL WRITING

  ➤ covers numerous types of professional documents for a specific purpose and specific audience.
• Examples of these are company projects, project proposals, sales brochures for marketing, manuals of instruction for specific instruments, journal articles, and reports on research studies as aids for policy making.
• Technical writing is OFTEN in a technology-centered field BUT NOT ALWAYS
• Sometimes referred to as business writing because it is used in a variety of businesses and disciplines.
• VISUAL EXAMPLES OF TECHNICAL WRITING

  User Manual. - Installation Guide

  Article Incorporation. - Technical Report

  • Medical Pamphlet
• 1. Writing process - brainstorming/prewriting, drafting, revision, and editing are still expected though they may vary slightly.
• Time/ effort - short doesn't mean easy or fast.
• • 3. Strong Language Skills grammar, punctuation, spelling, sentence structure, and word choice are still necessary.
• Research - if you don't already understand your audience, topic, and purpose, you must thoroughly research.
• Rules - most technical writing projects will require expertise in and of the field's writing conventions and or style guides.
• ➤ Audience - specific audience, usually professionals in a field with specific roles.
• Presentation - simple and clear organization. Favors visual accessibility and clarity over flow and transitions.
• Visuals - are highly encouraged and commonly used to better explain the information.
• •  Knowledge demonstrate enough knowledge about a technical subject.
• Information - objective. 100% Factual, true, and accurate. Never ambiguous. Emotion and opinion are highly discouraged.
• • Tone formal, specific, precise, direct, clear
• 3 THINGS TO CONSIDER

  1. What is the specific product or service?
  2. Who is the specific audience?
  3. What is the specific purpose?
• TECHNICAL REPORT

  ➤ is a form of technical writing
• TECHNICAL REPORT - The purpose is to completely and clearly describe technical work, why it was done, results obtained and implications of those results.
• Technical reports aim to inform readers about the methodology used, the data collected, the analysis performed, and the implications of the findings.
• Technical reports  EXAMPLES: proposals, regulations, manuals, procedures, requests, progress reports, and memos.
• STRUCTURE: Technical reports typically follow a more standardized structure, often including the following sections:
• Title page - providing essential background information and stating the problem the report is addressing.
• Abstract or executive summary - this page gives a concise and clear overview. It is written in such manner that a person only reading the abstract can gain complete information on the project.
•  Introduction - presents the problem, its background, and the context in which it is placed.
• Methodology - should detail the research design, procedures followed, and tools used for data collection and analysis.
• Results - this section usually presents raw data, which are then interpreted in the Discussion. Include NONE PROSE TEXT like charts, diagrams, tables, and graphs to present data collected.
• Discussion or analysis - section where the data from the Results section are analyzed and interpreted. This analysis often leads directly into the Conclusion.
• Conclusions - the report’s key findings are summarized, and their implications discussed. This section often suggests directions for future research.
• Reference or bibliography - section acknowledges all sources used during the research.
• Appendices - (for supplementary information) - (e.g large scale diagrams, computer code, raw data, specifications)
• • Title title, name, purpose, course name, department, date
• Abstract - 300 words, brief rundown of what the report covers, any conclusion or recommendations you make.
• Introduction - motivation, objectives, scope, limitation, content, organization.
• Background - history behind the problem, previous works and attempts to solve the problem.