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:most effective method for SME review? From:Tom Johnson <tomjohnson1492 -at- gmail -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 21 Oct 2015 17:12:18 -0700
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
- JIRA tickets
- Word docs
- comments on PDFs
- Google docs
- 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
email: tomjohnson1492 -at- gmail -dot- com
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com