How to write a user manual...??

[larrybud2002]

I suspect many developers here have had to write a technical manual for
their software, and I'm wondering if you have any info as to industry
standards for formatting.

For example, should a screen shot be included for each edit screen? If
so, how big? What if the picture won't fit on the page with the
corresponding text?

I realize the best way is to hire someone who knows all of this stuff,
but we can't afford it. Thanks!

 

[Steven Burn]

Can't stand writing them myself, damn things drive me nuts and take forever
and a day.

As far as screenshots go, though some would say to only include whats
necessary, the support e-mails I've received tell me every tiny detail
should be shown and explained.

As far as it not fitting on the page, most CHM editors allow you to use
thumbnails that link to larger screenshots (different app's have different
methods so cannot be more specific as to how).

As far as industry standard formatting goes, plane Jane HTMLHelp files
produce whats necessary. The older hlp format is apparently depracated and
PDF's are just a royal PITA

--
Regards

Steven Burn
Ur I.T. Mate Group
www.it-mate.co.uk

Keeping it FREE!

 

[McKirahan]

I suspect many developers here have had to write a technical manual for
their software, and I'm wondering if you have any info as to industry
standards for formatting.

For example, should a screen shot be included for each edit screen? If
so, how big? What if the picture won't fit on the page with the
corresponding text?

I realize the best way is to hire someone who knows all of this stuff,
but we can't afford it. Thanks!

What format will you be using -- MS-Word, Web page, or?

How will it be made available -- hardcopy, PDF, Web site, CD-ROM, or ?

What will you be documenting -- an application, a procedure, or ?


Google:

Online Technical Writing: Book Design
http://www.io.com/~hcexres/tcm1603/acchtml/book_design.html

Technical Writer (Technical Manuals/Reports Writing Software)
$150 http://www.writersupercenter.com/stylewriter/technical/

 

[larrybud2002]

Can't stand writing them myself, damn things drive me nuts and take forever
and a day.

As far as screenshots go, though some would say to only include whats
necessary, the support e-mails I've received tell me every tiny detail
should be shown and explained.

As far as it not fitting on the page, most CHM editors allow you to use
thumbnails that link to larger screenshots (different app's have different
methods so cannot be more specific as to how).

As far as industry standard formatting goes, plane Jane HTMLHelp files
produce whats necessary. The older hlp format is apparently depracated and
PDF's are just a royal PITA

I was writing it in Word, and creating a PDF. No good?

Word automatically creates a table of contents of proper styles are
used, and when it converts to PDF, the PDF index is automatically made
as well.