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: Looking for a Documentation automation solution
Subject:Re: Looking for a Documentation automation solution From:Scott Turner <quills -at- airmail -dot- net> To:Al Martine <almartine -at- inktopia -dot- net> Date:Mon, 7 Nov 2011 11:55:27 -0600
What Robert posted is the solution in a nut shell. The devil is in the details. Including Word files would require a certain amount of discipline in formatting from the authors, CAD drawings might need to be saved in a form other than DWG, etc., etc., etc.
Scott
On Nov 7, 2011, at 7:59, Al Martine <almartine -at- inktopia -dot- net> wrote:
> [written on behalf of Ann Waterhouse / AWaterhouse -at- apg-neuros -dot- com, please direct all private messages to her, thanks - Al ]
>
> We are looking for a documentation automation solution. Currently we are working on an Excel spreadsheet as a main data source. My boss would like something automated that would build documentation based on selections made in the spreadsheet (document assembly). As he discussed with me, he worked on a system that created military proposal documentation based on selections made from another system. That essentially created a large `boilerplate` document which could then be tweaked according to requirements. This is what he`s looking for.
>
> He understands the Excel may be on its way out and be eventually replaced by something else; what he would like to know is if there is some software out there that has the capability to create that boilerplate document he is looking for. This solution has to be able to handle large documents (300 â 900 pages; the software I`ve been able to find work primarily on smaller documents such as legal contracts and other business correspondence.
>
> The chosen solution needs to increase efficiency in a very labour intensive process and reduce errors and redundancies. The current process involves individually converting a group of files (Excel, AutoCAD and PDF) into PDF, copying them into a documentation folder, merging them into one large file (400 â 900 pages in either one or two separate volumes) adding PDF files for cover and TOC, sending it to the Project Manager for review and approval and then sending it to the client in print and CD formats. If the client has revisions (which they usually have), the whole process is repeated after changes have been made. This process is often performed more than once until client approval is given.
>
> Solutions should meet the following criteria:
>
> Â The ability to create documentation by selecting specific option in an Excel spreadsheet or other media
>
> Â The ability to create a manual by combining documents of various formats (XLS, Word, PDF, JPEG, DWG, PPT etc.)
>
> Â The ability to generate a cover (optional) and table of contents once the manual has been compiled
>
> Â The ability to make changes easily to the manual without the need to re-compile the entire manual. For example, during the revision process the client may request changes to only one document such as an Excel file detailing performance curves
>
> Thank you,
>
> Ann Waterhouse
>
> Senior Technical Writer/Redactrice Technique Principale
>
> O: 450 939-0799 ext: 2135
>
> F: 450 939-2115
>
>
>
> SiÃge Social /Headquarters
>
> 1270, MichÃle-Bohec
>
> Blainville, QC J7C 5S4
>
> Canada
>
>
>
>
>
>
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create and publish documentation through multiple channels with Doc-To-Help.
> Choose your authoring formats and get any output you may need. Try
> Doc-To-Help, now with MS SharePoint integration, free for 30-days.
>http://www.doctohelp.com
>
> ---
> You are currently subscribed to TECHWR-L as quills -at- airmail -dot- net -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/quills%40airmail.net
>
>
> To subscribe, send a blank email to techwr-l-join -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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-