Please enable JavaScript.
Coggle requires JavaScript to display documents.
Lab 1: Tech Documentation Project - Coggle Diagram
Lab 1: Tech Documentation Project
Learning the Adobe Audition Application
Selecting noise
Processing narration audio
Identifying noise
Technical Writing Style
Write For 7th Graders. ...
Write With Active Voice. ...
Write With Present Tenses. ...
Use A Style Guide. ...
Proofread.
Chunk Your Information.
Document Layout
Use of Color
Spacing and Proximity
Consistency
Segmenting
Accessibility
Screen Shots
Never share private info
Use Inspect Element to edit elements of web browser screen shots
Use blur tool in PHotoshop
Avoid auto-upload
crop the screenshot to show just relevant area
Make sure you show enouch context
Tools
Evernote web clipper
Windows Snip
Alt-Prnscr
Many others....
SnagIt
Annotations
Arrows
Circles/Boxes
Highlights
Development Process
Create a design plan
Audience
How it will be used
Define goal/objectives
Outline topics
Plan illustrations
Create Document Structure
Template
Layout
Fonts
Navigation queues
Create content
Draft
Use simple, clear language
thou shalt not assume
Short writing is good writing
Brevity
visualize what you’re saying rather than try to explain it.
Feedback
30/90 Rule
Edit
Review
Deliver & Test
Navigation Audit
Safety Check
Usability
How will documents be managed/stored?
Maintenance
Schedule
Scope of work
Research
General Helpful Tips
Up-to-date information
Consistent design and structure
Efficiency in development and use
Accessible anywhere :
Mobile friendly
Architecture Diagrams
Flow Charts
Process
Tools
Gliffy
Visio
Terrastruct
Draw.io
Workflows
InDesign
Layouts
Master Pages
Interactivity?
Tutorials
Paste in Place