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.
> I have to meet with a group of developers that want me to combine the
> API guides of our two main products into one guide because they say
> "Most of the API is the same and we want to have all the commands in one
> document" My pushback to them is that it is easier for the user if they
> have an API document per product.
Sounds like you're both right. If most of the content is the same, I'd
use one source file with conditional text to create outputs for each
product. Having all the commands in one place will make the document
much easier to maintain but customers will only see the information
they're interested in.
--
_____________________________________________________
Lee Hunter - Technical Editor & Information Architect
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
