TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
As part of our software documentation, our company has traditionally
provided UNIX-style manpages for the C and C++ APIs for the product.
Now that there are alternative ways to provide online documentation
(we also provide all our documentation online in HTML), we're
wondering if UNIX manpages are still necessary.
Lately I've encountered a few UNIX-based products that only distribute
manpages for command-line interfaces but not application-programming
interfaces. Do those of you who write documentation for UNIX products
distribute documentation as manpages? Has anyone noticed a trend away
from manpages?
*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*
Sandy Demi Transarc Corporation
demi -at- transarc -dot- com The Gulf Tower, 707 Grant St.
(412)338-4356 Pittsburgh, PA 15219
"No matter where you go... there you are." -- Buckaroo Banzai
*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*