Tech Documentation

Styling / Layout

Content

Spacing Issues

8 point system (content)

layout by columns of 12

Snap to Grid or KEYLINES

Fonts

Type System (in Word the styles pane), less than ten (probably 4)

Dividers

-Subtle,
-Secondary
-Infrequent

Overall Process

Seven Steps

  1. Understand the document's goals and target audience
  2. Write down vital questions
  3. Create an outline
  4. Compile the required data
  5. Compose a draft
  6. Utilise effective documentation visuals
  7. Finalise your editing

Make writing ONLY as long as necessary

Use images to highlight a point

Plan
Goals
Existing resources
Style guides
Topic outline
Tools + management
Deadline + deliverables

Annotation

Using SnagIt (and other tools)

Using Screenshots
1.Capture screenshots during storyboard development.

  1. Take quality screenshots the first time.
  2. Edit the image to make sure you’re not sharing personal information.
  3. Lock development at a specific software version.

Define THE SCOPE and stay within those bounds.