Initial steps before technical documentation
Technical writing has gained importance as a new stream of literature due to rapid advances in science and technology. The scientific knowledge is shared and made known through various media. Video is one method and news papers and internet is another.
Video requires a script that helps viewers understand what is going on. Communication of the technical advances through writing also involves script that people understand when reading it.
Rather than dwell on the various forms of technical communication I would go straight to the core of technical writing. When you write a document presenting technical information you need to follow a few steps.
Planning and producing a Technical Document requires you to identify what is the aim or purpose of the document. This is your statement of objective and its implicit and explicit purpose. This would be communication of research findings. It could be a user guide/manual. It could be a help for troubleshooting. Whatever the purpose it should meet its purpose.
The audience is another important aspect when you are writing your document. Who is going to read your technical document? Is it an expert, or technician? Or is it a manager or a lay person? Once you identify that it is easy to write.
The first step of writing a technical document is therefore identifying the purpose of the document and the audience the document is intended for.
Video requires a script that helps viewers understand what is going on. Communication of the technical advances through writing also involves script that people understand when reading it.
Rather than dwell on the various forms of technical communication I would go straight to the core of technical writing. When you write a document presenting technical information you need to follow a few steps.
Planning and producing a Technical Document requires you to identify what is the aim or purpose of the document. This is your statement of objective and its implicit and explicit purpose. This would be communication of research findings. It could be a user guide/manual. It could be a help for troubleshooting. Whatever the purpose it should meet its purpose.
The audience is another important aspect when you are writing your document. Who is going to read your technical document? Is it an expert, or technician? Or is it a manager or a lay person? Once you identify that it is easy to write.
The first step of writing a technical document is therefore identifying the purpose of the document and the audience the document is intended for.
posted by lizsavy at 1:27 AM
0 Comments:
Post a Comment
<< Home