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.
Subject:Re: tech doc - training cooperation From:Robert Fekete <fekete77 -dot- robert -at- gmail -dot- com> To:Erika Yanovich <ERIKA_y -at- rad -dot- com> Date:Thu, 15 Mar 2018 20:27:03 +0100
Hi Erika,
I think the trick here is to find a way to mark up parts of the docs to
appear somehow as slides. I can think of two ways to achieve this:
- One is to use a kind of strict template, for example, one where every
topic has an outline that is then extracted from the doc and converted into
slides, and the other parts of the doc come after that. That might not do
too much for deduplication, but at least it's singlesourcing.
- The other approach would be to explicitly mark up the things that should
appear on the slides, for example, if you are using an XML document that
consists of <paragraph> tags, you could add an attribute to the ones that
go into the slides (<paragraph output="slide">). Obviously, you need to
find a way after that to extract the marked up parts, split the content
into actual slides, and create the output presentation.
Note that this is mostly theoretical, I am not aware of any system that
actually supports it, though I know that Docbook has a markup for slides
(never used it though), and I have also seen Markdown+javascript systems
that create html presentations from plain text (for example, this might be
useful once you have already extracted the content from the main docs, and
need a way to convert it into a presentation.)
HTH,
Robert
On Mon, Mar 12, 2018 at 4:20 PM, Erika Yanovich <ERIKA_y -at- rad -dot- com> wrote:
> The good news is that we had special training for Tech docs and Training
> to prepare a customer-facing doc and a deck of slides about a complex
> issue. Although the slides would cover a subset to fit actual training
> sessions, the subset is large enough for us to consider avoiding
> duplication of effort between the departments. Is there a way to avoid such
> duplication and work in parallel?
>
> TIA
> Erika
>
>
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and
> content development | http://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as fekete77 -dot- robert -at- gmail -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
