integrating authored content with generated API docs

Subject: integrating authored content with generated API docs
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sat, 21 May 2016 10:43:58 -0700

Anybody using a system that does a good job of integrating API docs
generated with javadoc or whatever with human-authored content?

I set up a system with Document!X a few years ago. It let the tech
writer basically wrap the generated doc with additional content and
topics, which were preserved when the generated doc was updated.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

Previous by Author: Re: [RMX:NL] Re: Request for comments on my Structured Writing series
Next by Author: Re: integrating authored content with generated API docs
Previous by Thread: Need recommendation for document management tool
Next by Thread: RE: integrating authored content with generated API docs


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads