6 Matching Annotations
  1. Apr 2023
    1. A technical description's body can also include visual materials (and, conceivably, audio materials if the description is multimedia). These can be pictures, tables, diagrams, charts, graphs

      Keeping in mind what the subject is and the common conventions that writings in that subject include as far as visuals.

    2. If the audience both needs and can handle a lot of information, then get super-detailed. On the other hand, if the audience only needs or only can handle the basics for whatever reason, then keep the definition short and include just the absolutely necessary information.

      Taking into account not only the audience's age, but also what they will be needing this information for. For example, if you are writing a science experiment for a high school level course, you will want to include more information on the "why" of how it works more than you would if you were writing for grad students.

  2. Feb 2023
    1. Put standard measurement units (ft, mm, gal.) in the column or row heading rather than with each item in the column or row.

      It's also important to keep your units consistent across the table. If you use mL for one measurement, you should continue to use mL instead of switching to L or cm^3 in other places.

    2. Make notices' text succinct, but not at the expense of clear writing. Avoid telegraphic writing style (omitting articles like a, an, the) in notices.

      VERY important. I understand the urge to make notes short, but often people will make a note so short that there is a lot of information omitted. This defeats the purpose of writing a note in the first place.

  3. Jan 2023
    1. Something related to a progress report is a status report or status update. While a progress report reports upon the progress of a single project, a status report is a report on the status of your entire unit or department—it can encompass a range of projects and activities, and it is usually submitted at regular intervals—monthly or quarterly—regardless of what projects are underway.

      This is very useful for my field of work. Progress reports are longer and more in depth than a status update, but you need multiple status updates to write a progress report.

    2. If it is a longer memo (longer than a paragraph), you may wish to use section headers

      Section headers to separate longer memos is useful but is there a certain way to do it?