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.
Re: Seapine Surround for User Documentation Source Control
Subject:Re: Seapine Surround for User Documentation Source Control From:Mike Stockman <mstockman -at- gmail -dot- com> To:TECHWR-L Whirlers <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 10 May 2010 07:48:23 -0400
It sounds as if the goal of R&D is to be able to tag your source so they can build the exact release version of documentation at a future date, tied to a particular version of the code. If so, you may want to explore Author-it's own built-in version control. I remember it as being a pain to use and not-so-useful to me personally in 4.x, but perhaps it's better now. If you can point R&D to the Author-it source files (XML source living in a SQL database) being under a tag-able version control of their own, they may not only allow Author-it's source files to remain outside of their system, but they may encourage you to move the rest of the documents in as well.
Mike
On May 9, 2010, at 3:03 PM, SB wrote:
>
> Part of our documentation is maintained in MS Word, the other part is
> maintained in Author-it with Word and PDF as outputs. At some point, we will
> also have HTMLs.
>
> R&D wants the product documentation in Surround under the same tree as the
> code, per version. This allows them to take snapshots. I have no problem
> with that but I would like my PDFs and HTMLs together with my final (GA)
> release but they do not want outputs in there, claiming that the release is
> a different process, which means that I will have to store the PDFs and
> HTMLs elsewhere.
>
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
- Use this space to communicate with TECHWR-L readers -
- Contact admin -at- techwr-l -dot- com for more information -
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
