31 Matching Annotations
  1. Apr 2025
    1. The following are some helpful tips for incorporating headings in a report

      The tips are really helpful as heading are something that not only allows for breaks in text but also provides context on which topics you cover. Allowing the writer to focus on the topic when writing, as well as help the audience on the topics involved in the understanding of the report.

    2. the length and locations of these sections will vary, and some sections may be entirely eliminated

      This all is based on the research, purpose, and audience of your report. Changing the length and addition of sections to fit your report can help the communication between you, your research, and the audience.

    3. Another point to keep in mind relates to the audience for different kinds of reports

      Figuring out your audience will help in the process of research as well as writing. Knowing who your audience is and the context they already have will help you as a writer figure out what aspects you should focus on and the detail that would be beneficial to your audience.

    1. With so many sources available, the question usually is not whether sources exist for your project, but which ones will best meet your information needs?

      A lot of sources could exist involving the topic you are trying to cover. What's important is finding the right type of source and information that will not just benefit your hypothesis but also provide information and possibly context for your audience.

    2. What matters is that it addresses the following areas for your specific topic, genre, and audience. Does it:

      Following and answering these questions allows you to choose the right research type in order to have done research that is clear and cover the hypothesis and research questions you have created.

    3. What are the major questions that need to be answered for you to create a solid conclusion about your topic?

      This helps guide your research, helping you understand what needs to be covered for the hypothesis, as well as understand the research you must do.

  2. Mar 2025
    1. Make sure you use terms that are easily understood by the audience and define terms where necessary.

      Having to work to maintain a plain style while also appealing to emotion ca be really helped by knowing who your audience is and what they might need more insight in.

    2. ou may have to submit a proposal multiple times—making corrections, adding details to your research plan—before you receive approval to move forward with the project

      So far, a lot of the technical writing we have done have been short and don't require much review (other than the instructions). Learning that proposals are something that requires more time and research as well as multiple drafts is helpful.

    3. The proposal is your opportunity to pitch your idea for change (oftentimes an improvement) within an organization, or to draft a research plan to investigate an issue that is of concern to your institution.

      I've never really thought about a document that would communicate this, so it's interesting to learn about it.

  3. Feb 2025
    1. Minimally, design includes making choices about layout, order of information, font size, typeface, headings, color, and white space.

      All which are critical in making a document readable and easy to understand.

    2. For example, instructions for changing the oil in a car may explain why the task is necessary for the proper functioning of the vehicle.

      Including a reason as to why doing what the instructions are asking or even at least following instructions can improve communication between the reader and the writer.

    3. Because we do not find ourselves using them regularly or we come to expect them only in certain contexts, it is easy to forget how important they are.

      Instructions are interesting as they are very much based on technical writing. Instructions can also be important information shared in workplace settings, which make it all the more important for companies to also work on.

    1. This means that any document from memos and emails to proposals and studies can be subject to revision by a court of law.

      When working for a company it is not only beneficial to stay professional and ethical for your coworkers and costumers but also for any issues that may arise. Whether they involve public opinion or a legal issue these things can make or break a company's reputation.

    2. The main point is clear. When writing persuasively, do not write something that can cause the reader to believe something that is not true. This can be done by lying, misrepresenting facts, or just “twisting” numbers to favor your opinion and objectives.

      It is important to persuade and create a strong claim based on the facts that one has. If these facts do not benefit your cause, it is still critical to be honest.

    3. Many ethical lapses that occur in the workplace are not so obvious, and they often begin with good intentions

      Important to mention as technical writing is used in these environments the most. The examples given can be seen as small issues but can open doors to bigger ones.

    1. It is less versatile than the typical email in audience and formality level; its recipients usually consist of individuals within rather than outside of an organization, and it rarely adopts an informal tone

      It is important to remember that a memo is more specific, as it communicated important professional information in a formal tone. The audience may be less broad, but it remains specific as it important to communicate effectively and professionally within an organization.

    1. They are also useful for keeping writers organized and focused on the topic.

      A lot of writers, especially ones new to writing, may struggle in creating proper and helpful outlines. Having people start working on headers before the rough draft may help plan out the writing and the ideas better, which will in return help readers easily comprehend the document.

    2. This reader will usually read the entire report. Secondary readers are those who will read only the sections of the report that relate to them, their jobs, their departments, responsibilities, etc.

      I really appreciate the involvement of previous chapters and concepts. I think that explaining the importance of this besides formatting helping it be "easier on the eyes" and understanding a more specific reason for it and how it can help others, like different audiences, is helpful.

    3. when formatting an academic essay, you center your title and separate the content into paragraphs, which signals to the reader that it is time for a breather, the content is shifting slightly, or you are introducing a new topic

      I think this is an example that I appreciate, while I understand the concept I know that a lot of people may not fully grasp the concept of formatting without an example.

      While the other examples are good, having an example that is strictly based on paragraphs and written direction rather than other visual cues is important to fully understand the concept.

  4. Jan 2025
    1. It offers an opportunity to market your unique qualifications and to show how you will fit with the culture of the company.

      While a resume is good for showing overall, specific qualities and experience for a job, a cover letter is a way to communicate how you think you and your qualifications can fit into their culture and environment.

    2. to place more emphasis on a specific set of current qualifications and slightly less emphasis on your education or work experience

      It is important to really understand what the employer is asking of you in order to create resumes and letters that effectively show the experience and qualities that they are looking for.

    3. They want to ensure you have achieved that level of maturity before extending an offer.

      Accepting that you have weaknesses and being able to speak of them to others not only means that there is maturity in self-awarness but also maturity in communication. Having self-awarness is also important to self-improvment, if one is not aware of flaws, they don't see what to work on and having someone set them back on their team is unnecessary.

    1. It can be a great tool for connecting while on the go, but consider your company, and choose words, terms, or abbreviations that will deliver your message clearly.

      While texting is becoming more common amongst the workplace and everyday life it is still important to remember basic professional communication rules while also considering the new professional expectations that come with texting related to business.

    2. The introduction references background information and informs the purpose of the message. The body, consisting of one simple paragraph or multiple paragraphs, communicates the message. The conclusion expresses the action expected of the recipient.

      While certain companies may change the order of these expectations these are still the basic details of a memo, as it is efficient, professional, and known (I assume). Steering away from these loses the message of the memo.

    3. An email’s closing is extremely important because it identifies the sender and provides contact information. Always include your full name at the end of your email.

      An emails closing is important to the structure of an email, as it not only leaves an impression but also presents your person to the reader, as a name and at times a title is usually shared. Allowing readers a chance to further communicate while also allowing them the knowledge of who their audience is when responding.

    4. Your message is long (i.e. could not be read in 20 minutes or less), complicated, or requires additional face-to-face discussion.

      Emails are made of technical writing, that which focuses on straight forwardness and communication for all parties involved. If communication through an email isn't quick or efficient other means of communication would be more effective for the subject one is trying to communicate.

    1. If you write to the lowest common denominator of reader, you are likely to end up with a cumbersome, tedious, book-like report that will turn off the majority of readers. However, if you do not write to that lowest level, you lose that segment of readers.

      When thinking about an audience an issue I've seen was over explaining which may not just make most readers grow restless but also put too much pressure on the writer. It's good to want to explain but overexplaining can cause different issues. Finding the perfect balance of context for audiences, while also being true to the writer can only be practiced.

    2. You may have a client you are writing for or a group you specifically want to understand your ideas. In this case, you should write your document for the primary audience, but also include information for the secondary audiences.

      I think this a good example regarding pieces of technical writing that may seem to have less of an audience. In this case the primary audience would the client or clients, and the secondary audience would be coworkers or people in higher positions from yours who don't have as much context.

    1. Sometimes, the focus of technical communication is quite easy; the primary reader is clearly targeted through demographic research. But, think about how much more effective and more dynamic a communication could be if the writer considered the potential cultural perspectives at work.

      Writing can be simple if you only have one audience in mind, it's when you are speaking to multiple audiences at once where it grows challenging and where acknowledging cultural perspective becomes important during the creation of the work.

    2. Even within businesses, people with different skill sets need to be able to communicate effectively with one another; engineers need to communicate with lawyers; mechanics with accountants; sales people with managers and executives.

      I like the addition of businesses as an example, it shows real life examples of when technical writing may be needed and also the different audiences we may be speaking to, from people who may have more than basic knowledge to people completely who are new to the topic.

    3. The reader in turn thoroughly processes the information in order to give a thoughtful response or take appropriate action.

      Going into this class I understood that technical writing was a needed ability to thoroughly communicate for my associates but reading this shows me that it's more than just a sharing of information as it is also a tool to help communication run efficiently both ways even if the person on the other end isn't aware of technical writing.