Technical Writing(02)-Technical Document

 
  • 0 views

02 Technical Document

  1. Principles of design

    • placement of visuals and information

    • connection between these elements

    • Five major goals:

      1. Make a good impression on the readers
      2. Help readers understand the structure and hierarchy of the information
      3. Help readers find the information they need
      4. Help readers understand the information
      5. Help readers remember the information

    • The Non-Designer’s Design Book

      • Proximity

        • related items should be grouped together

      • Alignment

        • every element in it is visually connected to another element(invisible line)

      • Repetition

        • a certain style for each element in a design and use it on similar elements

      • Contrast

        • Unique or important elements in a design should stand apart from one another.
          • color
          • tone/value
          • size/shape
          • direction/space

  2. Designing visual information

    • Why visual matters?

      • “Visuals” speak louder than words

    • Types

      • Table

        • Numerical table

        • Prose table

      • Graph

        • Bar graph
        • Line graph

      • Chart

        • Flow chart
        • Gantt chart
        • Tree chart
        • Pictogram

      • Graphic illustration

    • How to choose the right visuals?

      • what is the purpose for using this visual?
      • who is my audience for these visuals

  3. Designing documents

    1. Shaping the page

      Provide page numbers, headers and footers

      • Title page

      • Text page

      • Use a grid

      • Use white space to create areas of emphasis

      • Use bulletin/number/check list

    2. Styling the words and letters

      • Select an appropriate typeface

        • Serif衬线字体

          • more readable
          • more traditional
          • newspaers, formal reports

        • Sans serif(without)无衬线字体

          • more clear and concise
          • technical materials/projected environment

        • Differences

          img

          • Serif 的字体容易辨认，因此易读性较高。反之 Sans Serif 则较醒目，但在行文阅读的情况下，Sans Serif 容易造成字母辨认的困扰，常会有来回重读及上下行错乱的情形。
          • Serif 强调了字母笔划的开始及结束，因此较易前后连续性的辨识。
          • Serif 强调一个word，而非单一的字母，反之Sans Serif 则强调个别字母。
          • 在小字体的场合，通常Sans Serif 比Serif 更清晰。
          • 中文字体中的宋体就是一种最标准的 serif 字体，衬线的特征非常明显。字形结构也和手写的楷书一致。因此宋体一直被做为最适合的正文字体之一。不过由于强调横竖笔画的对比，在远处观看的时候横线就被弱化，导致识别性的下降.

        • 中文:

          • serif ：宋体

      • sans serif: 黑体 、幼圆、雅黑

    • 英文

      • serif :Times New Roman
        • sans serif :Arial，Tahoma

    1. Use full caps sparingly

    2. Adding emphasis

      • Indention - Lines
      • Boldface
      • Small or large type sizes
      • Color

    3. Using headings for access and orientation

    • Topic headings
      • Usable page design
      • Statement headings
        • How to create a usable page design
      • Question headings
        • How do I create a usable page design