RE: Compellation program recommendations for Modular/Sectional documentation

[Diane Pol <Diane -dot- Pol -at- morbark -dot- com>]

Thank you, Nina!

I greatly appreciate the advice!  You are so right, it will not be a quick process, but will be worth it in the end.  I have started testing the product that we are currently using, to see what it is capable of.

Unfortunately, with our current system, to be able to pick specific modules for specific customers, I would have to resave the individual documents within that âBookâ.  This defeats the purpose of single sourcing the information.  I do not want to edit 200 or more documents when there is a needed update.

I am looking at a number of documentation products and hope to be able to find something that will work for us going forward.  Our goal is to be able to streamline, not only for the sake of edits, but to cut down on translation costs.

Diane


From: Nina Barzgaran <e -dot- dickinson -at- gmx -dot- net>
Sent: Wednesday, August 9, 2023 2:20 PM
To: Diane Pol <Diane -dot- Pol -at- morbark -dot- com>
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Aw: Compellation program recommendations for Modular/Sectional documentation

Hello Diane,

this sounds a little like sort of an 'overkill' for acquiring a CMS for that purpose, only - if you mean to do those "standard operating procedures", as they are sometimes called as well.
In a proper technical writing environment, an *editing office* as it were, you would look at (future) document numbers of around a couple of hundreds or even thousands; in such a case a CMS or rather CCMS is indicated.
Yet, again also referring to your mention of "documentation department's procedures" - you may want to use what's already in place.

Otherwise, you would want to *first* gather your requirements' list - and be careful to list future possibilities as well. Only after that look out for reviews and online-recommendations. Put together a list of applications that meet your requirements - as well as your budget.
Get a list of runners-up and start *evaluating*, not more than 4-6 candidates.

After evaluating, you would want to start testing of the most promising candidates, 2-3 on the outside.
You would maybe be right in asking: "All this trouble for a few documents?"
I would like to answer that possible question with: "It depends." On present and future requirements.
Setting up a proper CMS or even a 'help authoring tool' is not a piece of cake. But it will - if chosen wisely - stay with you for years on end making your life easier in the long run.

Hope this helps a little.

Nina




Gesendet: Montag, 07. August 2023 um 20:38 Uhr
Von: "Diane Pol" <Diane -dot- Pol -at- morbark -dot- com<mailto:Diane -dot- Pol -at- morbark -dot- com>>
An: "techwr-l -at- lists -dot- techwr-l -dot- com<mailto:techwr-l -at- lists -dot- techwr-l -dot- com>" <techwr-l -at- lists -dot- techwr-l -dot- com<mailto:techwr-l -at- lists -dot- techwr-l -dot- com>>
Betreff: Compellation program recommendations for Modular/Sectional documentation
I am at the beginning stage of my research for a Compellation program or possible CMS. I have read through numerous Techwr-l messages, as well as intercom and Technical Communication articles. I have also reached out to multiple industry mentors.

I am looking to update my departments documentation procedures, and therefor seeking insight and advice.

We are writing a series of documents, with each completed document showing a single procedure. The goal is to have the documents available in both on line and printed formats.

The online documents will be complete (modular/sectional) documents, for each individual procedure. The printed document, will be a custom selection of the modular/sectional documents, based on the client's needs.

My goal is to have an encompassing TOC, Index, and continual page numbering for the printed document. The online documents will have hyperlinks to related topics.

What program(s) have been used and are recommended for this type of process?


Thank you,
Diane Pol

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com

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

You are currently subscribed to TECHWR-L as e -dot- dickinson -at- gmx -dot- net<mailto:e -dot- dickinson -at- gmx -dot- net>.

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com<mailto:techwr-l-leave -at- lists -dot- techwr-l -dot- com>


Send administrative questions to admin -at- techwr-l -dot- com<mailto:admin -at- techwr-l -dot- com>. 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 | https://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