Overview: Students will learn to write clear, constructive technical documents, including user manuals and technical reports, to assess target audience and develop documents to meet their needs. The course will also include topics covering the appropriate writing styles for specialized audiences, building effective sentences, paragraphs and sections; employing diagrams, tables, charts and graphical applications, and choosing the right tools and media to create documents.
You will learn:
Applications of Technical writing
The technical writing process
Audience analysis including reader profile sheet, gathering information, technical interview, and documenting references
Phases of the technical writing process: planning, writing, delivery, archiving and evaluation
Style and terminology
Differentiating among different types of content including reference information, conceptual information and procedural information
Document design
Managing your documentation project: documentation design life cycle, working with teams and timelines
The technical writer’s tool box including context/text development tools, graphics software and clip art packages, help or web authoring tools and file conversion utilities