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.
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