Introduction to Technical Writing

-
Technical writing is a on demand platform. It is crucial for anyone working in a tech-related business, for engineers and software engineers.

When a software engineer  develop an application, technical writers should document the application working procedure.

Example applications are HRMS portal, Medical insurance application, Digital portals for various web applications etc.




These documents will help the people who uses that application. 
If any software engineer develops a HRMS application, end users will be the HRs of the organization. 

So the technical document prepared by the Technical Writer should help the HRs how to use the application. Technical Writers should understand about the targeted audience before starting of the document.

There are many definitions for technical writing. Few of them are

1. Technical writing is the process of creating software manuals or instructional guides. 

2. Technical Writing is Communicating about technical concepts, such as software applications, product manuals for the end users of the application.

Example documents of Technical Writing

a) User Guides
b) Instruction Manuals
c) Process documents
d) Proposals
e) Standard Operating Procedure
f) Research Reports
and so on...


There are huge opportunities for Technical Writing job openings in India. 

Skills required are
1. Excellent English Writing and reading skills
2.  Expertise in MS Word 
3. Expertise in Powerpoint
4. Strong understanding capabilities of software trends
5. Tools such as Framemaker/Robohelp etc

Comments

Post a Comment

Popular posts from this blog

Document Development Life Cycle - DDLC

-
Image
DDLC - Document Development Life Cycle is the process of steps involved in document creation. When Technical Writers wants to create a document, there are few specific steps involved. Those steps altogether called DDLC.    1. Requirement analysis    2. Understand Audience    3. Decide type of the document    4. Decide Style guides to use in entire documents    5. Develop the Content    6. Review the Document    7. Publish the Document    8. Maintain the Document     Requirement analysis -  Analyze the requirements of the document to prepare. Have a session with SME (Subject Matter Expert). From SMEs gather information such as What is about the application How many modules in the application Who are the end users of the application System requirements of the application Understand Audience :  Technical Writers should understand the who are the end users. If end users are non IT,...
Read more

Design knowledge required for Technical Writers

-
Image
 Technical Writers produce end user documents, manuals, process documents e,t,c Technical Writers require good English knowledge and writing capabilities. Along with those capabilities technical writers require some amount of design knowledge . Some times in the technical document, writers should include some graphics such as Design Flow diagram Process Flow diagram Screen shots of the application Electrical and Electronic circuits diagram Cover Page diagrams To draw these diagrams technical writer should know some concepts of graphic design tools. Some of the companies looking graphic design tool knowledge are Photoshop Snagit Visio Photoshop : Using photoshop, technical writes can design cover pages or they can create flyers kind of documents. If Technical writers have this knowledge, it will be added advantage and also in salary discussion they get more weightage. Using Photoshop they can deliver cover pages,  Also to edit the captured images and to resize the images Snagit...
Read more