What standards should I follow for user documentation?

Posted by moon on Stack Overflow See other posts from Stack Overflow or by moon
Published on 2010-04-12T07:35:23Z Indexed on 2010/04/12 7:53 UTC
Read the original article Hit count: 187

Filed under:

documentation

I have to write a user manual for my product, and I have been searching for a standard for the last three days. I didn't find any useful information. Can anyone guide me as to what standards exists for this purpose (User Manual Writing)?

If there are some good suggestions, that will also help me.

Thanks in advance.

Related posts about documentation

Hyperlinked, externalized source code documentation

as seen on Programmers - Search for 'Programmers'
Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive real-estate afforded to modern development environments (high-resolution monitors, dual-monitors, etc… >>> More
A tool to aid completion of missing or incomplete source code documentation

as seen on Stack Overflow - Search for 'Stack Overflow'
I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints,… >>> More
Quick C# Project Documentation in Visual Studio

as seen on Internet.com - Search for 'Internet.com'
Here's a quick way to document your .NET projects. >>> More
SQLAuthority News – Feature Pack for Microsoft SQL Server 2005 SP4

as seen on SQL Authority - Search for 'SQL Authority'
If you are still using SQL Server 2005 – I suggest that you consider migrating to later version of the SQL Server 2008/2008 R2. Due to any reason, you wanted to continue using SQL Server 2005, I suggest that you take a look at the Feature Pack for Microsoft SQL Server 2005 SP4. There are many… >>> More
SQLAuthority News – Statistics Used by the Query Optimizer in Microsoft SQL Server 2008 – Microsoft Whitepaper

as seen on SQL Authority - Search for 'SQL Authority'
I recently presented session on Statistics and Best Practices in Virtual Tech Days on Nov 22, 2010. The sessions was very popular and I got many questions right after the sessions. The number question I had received was where everybody can get the further information. I am very much happy that my… >>> More

Developer IT

What standards should I follow for user documentation? - Developer IT

What standards should I follow for user documentation?

documentation

Related posts about documentation

Hyperlinked, externalized source code documentation

A tool to aid completion of missing or incomplete source code documentation

Quick C# Project Documentation in Visual Studio

SQLAuthority News – Feature Pack for Microsoft SQL Server 2005 SP4

SQLAuthority News – Statistics Used by the Query Optimizer in Microsoft SQL Server 2008 – Microsoft Whitepaper

Categories cloud