Technical Writing

Technical Communication

  • Practice of conveying complex and specialized information (engineering and scientific terms + details) in a clear, concise and actionable manner to a specific audience.

    • bali porject proposal of research

    • since its project proposal it has to help like non engineers/scientists to understand difficult concepts

Key aspects:

  1. Purpose: The purpose lmao

  2. Audience-centered: tailor fit to who will consume the information

  3. Formats: Uses media such as visual and electronic aid (manuals, videos, FAQs)

  4. Adheres to these Core principles:

  • Clear

  • Concise

  • Cohesive

  • Complete

  • Correct

Common types of Technical writing

Technical writing: User manuals tutorials installation guides

Technical Editing: Review of documents for accuracy and clarity

Instructional Design: Creating training materials and tutorials.

User Experience (UX) Design: Designing how users interact with technical products.

Report Writing: Research, feasibility studies, and white papers.

Whats the difference from general communication?

  • focuses on precise language to eliminate ambiguity to ensure that the user succeeds in whatever

  • general communication is often subjective while technical is strictly functional.

  1. Primary purpose

  • Technical writings goal is to make complex information easy to understand and actionable. Again, it aims to reduce any confusion in the communication by focusing on efficiency

  1. Audience Centric Approach

  • Highly targeted towards a specific audience such as engineers and technicians (those who take action on it) and Higher ups (people who fund that might not be familiar with engineering terms etc)

  1. Clear and Concise

  • Uses direct and straightforward language, it strays away from metaphors and word play. It is mostly written in third person.

  1. Highly structured and Visual

  • Often organized in a list

Technical Report format

Notes:

Product Innovation is defined as the process of creating new goods and services or significantly improving existing ones.

(WE DONT HAVE TO MAKE A NEW ONE ITS JUST UPGRADING AN OLD THING)

  • Primary Goals: To meet customer needs, enhance functionality, and gain a competitive edge in the market.

  • Scope: It covers both tangible improvements (such as materials and physical design) and intangible upgrades (such as software and user experience).

  • Scale: Enhancements can range from minor, incremental changes to major, market-disrupting breakthroughs.

  • Should have an original name

  • Must have an inspiration product

  • Ensure it can be assembled (avoid business innovation or service innovation)

  • Anchored in 17 Sustainable Goals

  • Related to Program

In project descriotion, Set specific objectives and goals as we work toward the project. This alongside what it addresses and the parcitular problem/existing solutions

For our innovation:

  • Mechanism description

    • provides the physical aspects of a tool, machine or mechanical device (which is ours)

  • Definition

    • Glossary of terms if there are too many technical terms

  • Assembley and testing

    • Step by step process on how the innovation can be created and tested (before mass distribution)

    • Written in steps and procedures instead of paragraphs

Discussion section
- must include the SWOT analysis, technical report, relevant findings challenges, include what was not clearly elaborated and discussed