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.
Hi,
we have different kinds of review.Review of documentation is done usually with Word Files and Mark Changes, sometimes with additional comments.
The original is Robohelp, and after review we transfer the proposals to Robohelp.The proofreading task is assigned formally to the SMA and after proofreading back to the technical writer.
If there are mayor changes necessary, we discuss it in a meeting.
Best regardsBernd
"Cardimon, Craig" <ccardimon -at- M-S-G -dot- com> schrieb am 16:42 Donnerstag, 22.Oktober 2015:
The approach that works best for me is:
* Whatever the SME feels like doing when they feel like doing it.*
Getting an audience with an SME is sort of like getting an audience with The Pope: If it actually happens, you feel as though the universe has smiled upon you.
~Craig
-----Original Message-----
From: techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Tom Johnson
Sent: Wednesday, October 21, 2015 8:12 PM
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: most effective method for SME review?
What has been your most effective method for reviewing docs with subject matter experts? I feel like I've tried everything and haven't really hit upon the best way of doing it.
Some approaches I've tried:
- comments forms on web pages
- direct edits of source files on Github
- in-person visits at my desk
- email
- JIRA tickets
- Word docs
- comments on PDFs
- Google docs
- Beegit
- focused meetings
- over-the-shoulder sessions
My reviewers say they like to highlight passages and put their annotations the margins, similar to Google Docs. The only problem with that approach is that (1) Google Docs is prohibited at my work for enterprise content review, and (2) importing content into Google Docs munges the formatting (there's no bulk import/export).
Nevertheless, Google Docs has been the best reviewing tool for my content (at least at a former company where we had Google Drive instead of MS Office). Beegit approximates Google Docs and allows you to use Markdown as the source, but there's no bulk import, so there's a lot of copying and pasting involved.
Tom
---------------------
blog: idratherbewriting.com
twitter: tomjohnson
email: tomjohnson1492 -at- gmail -dot- com
cell: 408-540-8562
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
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
Information contained in this e-mail transmission is privileged and confidential. If you are not the intended recipient of this email, do not read, distribute or reproduce this transmission (including any attachments). If you have received this e-mail in error, please immediately notify the sender by telephone or email reply.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
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
