Book 1: Technical Writing

Table of Contents of Book: Technical Writing

 
 
In the last couple of years, there has been a sudden increase in the need for technical writers in India. These days many multinational companies having their development centers in India are setting up their documentation teams here. Though many organizations are ready to hire freshers and provide them with in-house training, it is often diffcult to find someone who fits in the bill. This is due to lack of understanding of the job profile and the attitude of some of the freshers toward technical writing as career.
 
Though there is no dearth of books on this subject, there is de nitely a lack of good reference books specific to the Indian audience that teaches them about the basic requirements of technical writing. These aspects are taken for granted in the other countries where technical writing has been a career option for more than 2-3 decades. So, the books by foreign authors does not focus on the basic requirements of the Indian readers.

This book is dedicated to all those who want to know about technical writing.

 
Part I: Introduction
  1. Frequently Asked Questions
  2. Introduction to Technical Writing
  3. Skills of a Technical Writer
  4. Documentation Types
Part II: Documentation Development Life Cycle (DDLC)
 

    5.   Documentation Process
    6.   Integrating DDLC with SDLC
    7.  Planning the project
    8.  Determining the Audience
    9.  Writing
   10. Reviewing the Documents

Part III: Post-Writing Process

    11. Techncial Editing
    12. Indexing
    13. Looking Back and Ahead-Postmortem

Part IV: Styles and Standards

    14. Good Documentation
    15. Quality and Usability of Documents
    16. Setting the Standards and style
    17. Guidelines

Part V: Structure of the Document

    18. Organizing Information
    19. Structuring the Information
    20. Parts of a Documents
    21. Structuring Various Documents

Part VI: Technical Writer At Work
    22. Becoming a Technical Writer
    23. Technical Writing as a Career
    24. Writing an Impressive Resume
    25. Attending an Interview
    26. At work
    27. Team Culture

Part VII: Language and Checklists
    28. A Dozen Punctuation Rules
    29. 20 Rules of Effective Writing
    30. Frequently Misused Words
    31. Checklists

Part VIII: Appendices
    A. Localization
    B. Graphical User Interface
    C. Technical Writing Tools
    D. A comparative Study: Chak De India

Who Can Use This Book

This book covers all the basic aspects of technical writing and so, it is a one stop reference point for the new writers and even those who are pursuing a career in this field. This book is not restricted to the technical writers. It can be used by anyone.

  • Freshers who want to know about the job profile to help them to take appropriate decision about choosing technical writing as a career.
  • Writers already in the field and who want to improve their knowledge and skills. This will help them them understand the different aspects of the work and the job profile.
  • Technical translators so that they understand the process of documentation.
  • Marketing executives, to get an understanding of the fundamentals of audience analysis and to create marketing materials and proposals.
  • Managers (not related to documentation) who are responsible for recruiting technical writers and setting up a documentation team.
  • Recruiting managers, to understand where documentation ts in the organization and to understand the skills required for a technical writer.
  • Institutions conducting courses in technical writing can use this as a reference book or textbook.
  • Anybody who wants to understand the basic concepts of technical writing.

Details for Purchasing the Book:

Publisher: Himalaya Publishing House (March 2008)
Pages: 570
Cost Rs 375/- for paperback
         Rs 1450/- for hard bound

Can purchase it by contacting their local offices at:

  • Delhi (011-23270392, 011-23278631)
  • Pune (020-244966333, 24496323)
  • Bangalore (080-22281541, 080-22385461)
  • Hyderabad (09848130433)
  • Chennai (044-28144004, 044-28144005)
  • Nagpur (0712-2721215)
  • Mumbai (022-23877178)

Also available at:

Advertisements

One Response

  1. […] is an excerpt from my book “Technical Writing” published in […]

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: