Tek-Tips is the largest IT community on the Internet today!

Members share and learn making Tek-Tips Forums the best source of peer-reviewed technical information on the Internet!

  • Congratulations Chris Miller on being selected by the Tek-Tips community for having the most helpful posts in the forums last week. Way to Go!

User Documentation - suggested standards?

Status
Not open for further replies.

misbrandy

MIS
Jun 12, 2007
41
US
First, not sure this is the right forum, let me know if I should move.

As a side project I am taking all the company documentation and redoing it all using one common format. It will be job or function-specific, not software application-specific, but will primarily deal with how to use all the software to perform a particular job function.

I have poked around on the internet to find some standards, but the only thing I've found is the IEEE document which I do not have access to.

I'm looking for suggestions on things like standard notation conventions to use (like ALL CAPS for screen prompts, italics for words user types), what to include (Table of Contents), etc.

Any ideas? Samples?
 
I'd say, this is beyond a specific reporting tool forum. So, move to a more generic forum?

Ties Blom

 
Status
Not open for further replies.

Part and Inventory Search

Sponsor

Back
Top