In today's world we are surrounded by computers which run everything from manufacturing processes to tracking shares on the Stock Market. Each of these applications is likely to be complex enough that the user will need a book to tell them how the software works and what it can do. Writing software documentation might be done by the person who wrote the program, but large applications may require a technical author to produce the final manual.
Employing a technical author to write end user manuals allows the world of the techie to be translated into a language that anyone can understand. Their strength is the ability to explain complex programs to the person who will have to use it and has never seen the menu system or interface before. Computer programmers rarely have this skill as they make frequently look at the application from the code level rather than through the user's eye.
Many systems these days have very intuitive interfaces which require almost no documentation. Games particularly are designed so that the player learns as they go along. Early levels teach you the basics of the game and hints or tricks are introduced along the way. This technique however cannot be applied for example in running a power station.
Some of the best documentation is written by authors who start from the point of view "How can I do this" and then write instructions which can be followed easily to achieve results from each portion of the app. By following a standard format which take the user from starting the app, through its menu and functions through to what needs to be done in the event of problems, they can produce a comprehensive guide. This guide may then be formatted to a certain specification reflecting the company's style.
A writer needs to know who the end user will be for the documentation. If the manual contains too much technical information it is useless to a non-techie. One which is too simplistic is of little use to IT professionals who might need it for support purposes. The writer needs to pitch the text at the right level for the target audience.
Any manual should be clear, concise and laid out so that the information flows in a logical manner. The complexity of the application will often determine the size and format of the final document. A very simple menu system might only require a few pages while a very specialized interface might need a tome the size of War and Peace.
However large or small the finished article, it must cover all the basic information which a user will need. They must be able to start the app, use all its functions correctly and know where to turn if things go wrong. Inclusion of pictorials showing menus, screen shots or other helpful diagrams is extremely helpful and works well in online and printed documents.
Collaboration between the writer, user and programmer is a great way of writing software documentation. The technical aspects can be explained clearly by the programmer to the writer while the user can give input on what they need to know. This should produce a final manual that everyone can be happy about. Good manuals ensure all the information is there while still being readable and easily understood.
Employing a technical author to write end user manuals allows the world of the techie to be translated into a language that anyone can understand. Their strength is the ability to explain complex programs to the person who will have to use it and has never seen the menu system or interface before. Computer programmers rarely have this skill as they make frequently look at the application from the code level rather than through the user's eye.
Many systems these days have very intuitive interfaces which require almost no documentation. Games particularly are designed so that the player learns as they go along. Early levels teach you the basics of the game and hints or tricks are introduced along the way. This technique however cannot be applied for example in running a power station.
Some of the best documentation is written by authors who start from the point of view "How can I do this" and then write instructions which can be followed easily to achieve results from each portion of the app. By following a standard format which take the user from starting the app, through its menu and functions through to what needs to be done in the event of problems, they can produce a comprehensive guide. This guide may then be formatted to a certain specification reflecting the company's style.
A writer needs to know who the end user will be for the documentation. If the manual contains too much technical information it is useless to a non-techie. One which is too simplistic is of little use to IT professionals who might need it for support purposes. The writer needs to pitch the text at the right level for the target audience.
Any manual should be clear, concise and laid out so that the information flows in a logical manner. The complexity of the application will often determine the size and format of the final document. A very simple menu system might only require a few pages while a very specialized interface might need a tome the size of War and Peace.
However large or small the finished article, it must cover all the basic information which a user will need. They must be able to start the app, use all its functions correctly and know where to turn if things go wrong. Inclusion of pictorials showing menus, screen shots or other helpful diagrams is extremely helpful and works well in online and printed documents.
Collaboration between the writer, user and programmer is a great way of writing software documentation. The technical aspects can be explained clearly by the programmer to the writer while the user can give input on what they need to know. This should produce a final manual that everyone can be happy about. Good manuals ensure all the information is there while still being readable and easily understood.
About the Author:
Read more about Tips For Writing Software Documentation For End Users visiting our website.
No comments:
Post a Comment