This is the one “eternal” question I keep asking myself since I started learning and working on FrameMaker.
Here is a small snapshot of what I understood.
When it comes to creating long technical documents with multiple indentation levels and a 3, 4 even 5-tier paragraph numbering system, there’s no contest FrameMaker wins hands down.
The reason is simple; Framemaker was designed for long, complex technical documents, and is very cumbersome for short documents. If you have a good template, things almost never go wrong with FrameMaker.
On the other hand, MS Word was designed to be a simple word processor to create short documents. But Microsoft has gradually evolved MS Word to have much more sophisticated features. Now, MS Word can support for longer and more complex documents. But sometimes lists or headers and footers, or something else do go wrong unannounced.
Still, MS Word is on almost every office computer across the world. It’s everywhere. And it’s much easier to learn than FrameMaker, though not easier to master. Moreover, MS Word is more affordable, which often influences buying decisions of the organizations.
If a department’s documentation needs are preparing for 4-page software/hardware installation guide, then MS Word will do just fine.
But in case the organization has to generate a 1,000 page User and Configuration Guide for particular instrument or industrial plant, then FrameMaker is the right choice.
I will continue to update this blog regularly and bring up more distinguishing features between Adobe FrameMaker and MS Word.

Technical documentation refers to create the deliverable by the Technical Writers using various documentation tools. The deliverable must be crisp, short and user friendly in every respect. Every product comes with a document. It might be user manuals, troubleshooting guides, online help files, installation guides, quick reference guides etc.

Various tools are required to meet different prospects of technical writing which eventually bring out a complete and efficient document. Some of those are discussed below:

• Publishing Tools
• Help Authoring Tools
• Template Designers
• Image Editors
• Web Design Tools
• Screen Recording Tools
• Multimedia Tools

Publishing tools

• These tools include Microsoft Word and Adobe FrameMaker.
• MS Word is dominantly used as it is easy to write, edit and review irrespective of bugs and its limitations.
• For documents of more than 500 pages, the Adobe FrameMaker is the best available publishing tool as it maintains consistency in styles.
• FrameMaker also handles large amount of text and graphic in it unlike getting corrupt as in MS Word.

Help authoring tools

• These include Adobe RoboHelp, Epic Editor and AuthorIt to prepare online help files.
• With the popularity of internet and interest of the users to solve their queries referring to the online documents, the online help files are taking over the paper manuals as they are easily searchable and accessible.

Template designers

• Every document needs a specific template which is a flexible layout based on the typography demands.
• Some of these tools are, Indesign, PageMaker,QuarkExpress.
• Datasheets, Whitepapers, Brochures, Solution sheets and various marketing and technical documents can be created and designed using these tools.

Image editors

• A graphic representation is always more helpful than the texts to navigate the audience to their required goal.
• Image editors are used to capture, crop, design, morph the images required.
• Some of the popular image editors are Adobe Photoshop, Adobe Illustrator, SnagIt, CorelDRAW.

Web design tools

• To create deliverables as web pages for the end users, web design tools are important.
• Both static and dynamic content can be created using tools like Adobe Dreamweaver and Microsoft Frontpage.
• These are primarily HTML editors with both visual and code level capabilities.

Screen recording tools

• Screen recording tools include Adobe Captivate, Camtasia which helps to create product demos, scenario based training, simulations etc.
• The tools do not require programming knowledge and multimedia skills.

Multimedia tools

• To create audio and video content in a technical document, multimedia tools such as Adobe Flash, 3D Max  are used.
• These are helpful in creating interactive animations and demonstrations.

Though these are the basic tools required for technical documentation, there are various other tools such as Lectora, Visio etc. can be used to create content and graphics.

Anima Ankur completed her TWB Associate Certification Program in 2011. She is currently working as an IT Consultant in the Technical Writers Team at Fujitsu. She has a Masters in Computer Application.

What has been the most challenging experience (professionally) to date?

Being a Technical Writer my biggest challenge was to write a Technical Manual for a product ready for Alpha release where the scope of research was very limited and deadline was very crucial.

How does your job as a technical writer influence your life? Do you feel that you see things around you differently?

My job as a Technical Writer requires good planning, multitasking and great time management skill, which is now applicable in my life too. These skills help me to manage my professional and personal life smoothly.

If you could trade places with any other person for a week, famous or not famous, living or dead, real or fictional with whom would it be and why?

I admire Steve Jobs for of his vision and transforming it into reality.

Is there any particular to-do-list to follow to become a successful technical writer?

To become a successful technical writer to-do- list is long, but my list is following:

• Keep myself self motivated every morning for daily challenges.
• Plan a day
• Punctuality
• Follow the GRAPE method while writing
• Note all doubts in a notepad and get it clarified at regular interval.
• Proper communication with all Team members
• Follow the Checklist and make sure it’s complete on daily basis.
• Take feedback (positive or negative) always positively

If you could start again, what would you do differently?

If I could start again, I would have joined The Writers Block (TWB) three years back.

If Hollywood made a movie about your life, whom would you like to see play the lead role as you?

Helen Hunt

What resources do you use when it is necessary to expand or correct your vocabulary while you are writing at work?

For good writing, correct vocabulary is most important and for this following are the resources I use:

• Online dictionary: http://www.merriam-webster.com/
• Style Guide: Manual of Style for Technical Publications (MSTP)

According to you, what are the three important skills required to be a good Technical Writer?

Apart from good professional writing skill following three skills are required to be a good Technical Writer:

• Good information gathering skill: passionate about information development
• Good Planning skill: Self driven
• Quick learner: Self motivated
• Training and Certification from good institute helps enhance these skills.

A Technical report is a document that describes the process, progress, or results of a particular research and development activity undertaken. It includes the recommendations, conclusion and the future work of the research done.
Technical report presents a detailed account of the various phases of the research project using textual, statistical, analytical and graphical aids. Technical reports are usually not peer reviewed. While writing a Technical report following things need to be defined:
Report Topic: Decide on what subject you are going to write. It’s always good to narrow it as much as possible.
Report Audience: Define a specific person or group of people for whom the report is written.
Report Purpose: Define what the report will accomplish
Report Type: Decide on the type of report
Students at the university level prepare Technical Reports in their final semester of graduation and post graduation studies. At the university, reports are read by lecturers and tutors in order to assess student’s subject knowledge and ability to apply the technical skills gained in a practical task.
At workplace, technical reports are read by managers, clients, colleagues.
Example of technical report:
Climate change in Australia: technical report 2011