Technical writing training 2013 14 (2)

TECHNCAL
WRITING
All rights reserved. ‘CrimsonLogic’ and the Shell Device are trade marks of CrimsonLogicPte Ltd. All information contained in this presentation is disclosed to you on the basis of a
prospective business relationship and is proprietary to CrimsonLogic Pte Ltd and may not be used, disclosed or reproduced without the prior written consent of CrimsonLogic.
CrimsonLogic Copyright 2013 Private & Confidential
1

Agenda
2
What is Technical Writing
What Tech Writers Do
Documentation Process
Writing in Process
Types of Technical Documents
Software Tools used by Tech Writers
Points to Ponder

What Tech Writers Do
Tech Writers understand complex information and make it easy
for people to use the product. A technical writer's job is to allow
others to be relaxed and comfortable.
Technical writer bridges the gap between the developers and
the end users. They make sure that all the necessary information
about a product or service is communicated in a clear, concise,
accurate way for internal and external audiences.
Technical writing is quite different from all other responsibilities in
an IT company. It is not about the skill, technology expertise or
the job responsibility. It is something [i]different[/i].
CrimsonLogic Copyright 2013 Private & Confidential 4

Documentation Process
Document Development Life Cycle (DDLC) is considered as the complete life cycle of a documentation
task. Software documentation requires a well-defined methodology for the successful completion. DDLC
should encompass and go along with Software Development Life Cycle (SDLC) because both are
parallel as well as intertwined.

Writing in Process
Good writing doesn’t happen overnight; it requires
planning, drafting, rereading, revising, and editing..
Learning and improvement requires self-review, peer-review,
subject-matter expert feedback, and practice.
There are no shortcuts; practice makes perfect!

Types of Technical Documents
Technical writers mainly create documents for end users.
1. Technical ( hardware and software) products.
User manuals for computer programs,
 online help,
white papers,
Release notes,
Admin manuals,
Installation guides
Troubleshooting guides
'frequently asked questions' (also known as FAQ) pages to help technical staff,
consumers and other users.
2. Marketing communication- These documents are for general audience.
Product catalogs,
white papers,
brochures,
training materials.
The various fields where technical writers serve are Aeronautics, Robotics, Finance,
Consumer Electronics.

Tools and Techniques
How is the information communicated? There are many methods used, such as online, in a cloud, via an
intranet or company network, in print, multimedia presentations, video or using various media devices.
The following types of tools are typically used to author and present technical documents:
1. Desktop Publishing Tools or Word Processors are used to produce printed manuals or digital
documents in print format. Microsoft Word and Adobe Frame Maker are two tools commonly
used by technical writers.
2. Help Authoring Tools are used to create online help systems, which are either packaged with
software products, delivered through a web browser or provided as files the user can view on
their computer. Adobe RoboHelp, Madcap Flare, Author-it and HelpNDoc are commonly used
tools.
3. Image capturing tools – SnagIt, Capturewiz.

Points to Ponder
1. Use the Page layout as Portrait and not landscape for writing documents
2. Use the template for documenting any user guides which is kept in tech writing repository
3. Always make use of the styles in the template don’t use generic styles
4. Use the Track changes or comment option to comments on the user guides
5. Remove the Draft watermark before sending the final copy
6. Let us know earlier if the client wants the user guide
7. Involve the Tech Comm team from the beginning of the project as it would be easier for the tech
writer to understand about the product and can start doc based on understanding instead on relying
on the developers very often
8. Keep updating on the changes made to the user guide or the application
9. Do not send the guides without technical reviews to the clients
10.We have a Visio installed if any diagrams needed for any project let us know

THANK YOU
10
Laxmi & Jaisree.D.B (UAV Team)
laxmism@crimsonlogic.co.in
jaisreedb@crrimsonlogic.co.in

Technical writing training 2013 14 (2)

More Related Content

Similar to Technical writing training 2013 14 (2) (20)

Technical writing training 2013 14 (2)