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.
How does the company expect the XML based topics to be written? If the
engineers are afraid that editors might write code that invalidates
the DTD or schema, you could suggest using a front end client like
XMLmind that doesn't let you insert invalid elements in the first
place.
Which CMS are you using? The more advanced ones let you manage review
cycles at the XML stage. PDF reviews are inefficient, and a major step
backwards.
If I started from scratch, I'd look at exporting XML to a wiki as a
final output. Instead of letting readers edit the actual pages, I'd
include a threaded comments form at the bottom. My favourite example
of a reference guide is the PHP manual (sample page: http://www.php.net/manual/en/language.types.float.php )
My only complaint is that the comments aren't threaded.
Good luck!
-Tony
On 2011-09-09, at 3:00 PM, <kristy -at- kristylantzastry -dot- com> wrote:
> Cross-posted to HATT
> We're in the early stages of implementing a CMS. Our editors are being
> told that they won't be given access to the XML-based topics. Instead,
> each editor is expected to comment on the grammar, punctuation, syntax,
> and document structure in a generated pdf, which is returned to the
> technical writer for correction before the document is sent for
> technical review.
> We writers and editors believe that editors should be able to correct
> the minor grammatical issues in each topic, before a document is
> generated. But, as always, we need to convince upper management with
> facts rather than feelings.
> Regardless of your type of CMS and subject matter, what's your editing
> process? Do your editors work strictly with documents written by native
> English speakers, or do they also edit documents written by ESL
> writers? What works and doesn't work for you? How has your editing
> process changed since implementing your CMS?
> Thank you for any and all advice.
>
> Kristy L. Astry
> 2011-2012 STC RMC Past President
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 tonyc -at- tonychung -dot- ca -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/tonyc%40tonychung.ca
>
>
> 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.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
>http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
