IT Employment

General discussion


Documentation Layout

By susian ·
I was assigned to design and come out a company documentation (Eg:- Process Flow, User Guide, Technical Guide and etc). But I do not know how and where to start. It will be greate if you could provide me some suggestion. Thanks

This conversation is currently closed to new comments.

Thread display: Collapse - | Expand +

All Comments

Collapse -

by michance In reply to Documentation Layout

That's a very broad assignment. Much will depend on the nature of your business.

A simple process flowchart can easily be put together with a tool such as Visio. To get the informatin you need, you can interview people involved in the process, or observe them as they work.

User Guides can be paper or electronic. Word and RoboHelp are excellent tools or intermediate efforts. Again, you will be interviewing developers/engineers, and/or working with the products yourself, to get the source information you need for your documents.

As for guidelines, there are many books that help you determine outlines and content for these kinds of documentation.

Further, you might consider getting involved with your local chapter of the Society for Technical Communication (STC). This will make available to you many very experienced people who will be happy to help you as you work through your assignment.

I hope this helps. Best of luck to you.

Collapse -

by susian In reply to Documentation Layout

This question was closed by the author

Related Discussions

Related Forums