Re: integrating authored content with generated API docs

Subject: Re: integrating authored content with generated API docs
From: Mark Baker <mbaker -at- analecta -dot- com>
To: Robert Lauriston <robert -at- lauriston -dot- com>
Date: Sun, 22 May 2016 15:09:29 -0400

Check out this new post by Sarah Maddox: https://ffeathers.wordpress.com/2016/05/23/api-doc-tools-at-write-the-docs-na-2016

Sent from TypeApp



On May 22, 2016, 12:42 PM, at 12:42 PM, Robert Lauriston <robert -at- lauriston -dot- com> wrote:
>I suspect there is no off-the-shelf tool, but my starting point will
>probably be Confluence or some other XHTML or XML wiki.
>
>I've been looking at various approaches people have taken to get
>javadoc output etc. into Confluence, but so far they all seem to have
>serious limitations.
>
>I suppose the ideal would include a button developers and tech writers
>could click to open the source in their IDE.
>
>On Sat, May 21, 2016 at 8:47 PM, <mbaker -at- analecta -dot- com> wrote:
>>
>> ... I'm guessing you are probably looking for more of a COTS
>solution. ...
>^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>Visit TechWhirl for the latest on content technology, content strategy
>and content development | http://techwhirl.com
>
>^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
>You are currently subscribed to TECHWR-L as mbaker -at- analecta -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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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


References:
integrating authored content with generated API docs: From: Robert Lauriston
RE: integrating authored content with generated API docs: From: mbaker
Re: integrating authored content with generated API docs: From: Robert Lauriston

Previous by Author: RE: A Day in Technical Documentation History
Next by Author: RE: integrating authored content with generated API docs
Previous by Thread: Re: integrating authored content with generated API docs
Next by Thread: Fwd: integrating authored content with generated API docs


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

Sponsored Ads


Sponsored Ads