RE: Man pages Was RE: Structure for GUI & Command Line Input Doc

["Dave Murray" <davemurray -at- attbi -dot- com>]

>Does it even make sense for engineering to ask us to provide installation
instructions as man pages, and if so, >what would be involved in translating
our Frame files to this format?

It does seem like an odd request, especially since your product is
browser-based.  Do they want internal installation docs for their use only?

I used to write man pages as part of an administrator's guide, but they were
only for describing the commands themselves.  Man pages themselves are more
like reference documents than procedural ones.

If the engineers really insist on this format for installation instructions,
you might want to try saving the relevant pages of the Frame doc as plain
text and sending it to them as a separate file.


Dave Murray

Technical Documentation & Online Help Systems

mailto:davemurray -at- attbi -dot- com
http://home.attbi.com/~davemurray/tw.htm






^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr

Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot-  Visit http://www.raycomm.com/techwhirl/ for more resources and info.