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.
I hear you about the display markup feature in Word! Itâs annoying.Â
I guess itâs not just the reviewers/approvers but everyone whom weâd like to relieve from re-reading the entire document when there is a change.Â
We do have a Document Control section that includes a revision history table.Â
HallieÂ
On Thursday, July 26, 2018, 3:11:29 PM EDT, Wright, Lynne <Lynne -dot- Wright -at- Kronos -dot- com> wrote:
I just use Word's track changes feature to highlight content that has been added or modified since the last release, so that reviewers can see what's changed.
For big docs, you could also add some kind of tag word (like "new") or symbol that would allow reviewers to use search to quickly go to the bits that they need to look at/approve. When the review is done, you remove the tag words and turn off change tracking before generating the pdf. (if there's a Word feature that automates this, I'd love to hear about it!).
I also include a revision history table at the beginning of the doc that lists the sections that are new or were modified (with a summary of what changed: i.e. "parameters table was updated") so its easy for end users to tell what's changed.
-----Original Message-----
From: techwr-l-bounces+lynne -dot- wright=kronos -dot- com -at- lists -dot- techwr-l -dot- com <techwr-l-bounces+lynne -dot- wright=kronos -dot- com -at- lists -dot- techwr-l -dot- com> On Behalf Of lover of words
Sent: Thursday, July 26, 2018 11:09 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Model for Creating/Tracking Document Addenda/Errata
Hello. I am in the energy industry, responsible for managing standards and specifications documents. We use a MS Word âPDF âDocuSign manual workflow and then post to SharePoint for end user access.Â
Iâm looking for models for managing the development and approval of addenda and errata related to an individual document.Â
I may also take this opportunity to switch from DocuSign to a SharePoint approval process since itâs all internal and encryption is really not necessary (we just started using it as a way to standardize the process).
So we would want to be able to quickly publish and approve some new information added to the document in a manner that doesnât require recreating the whole document or having approvers re-read the entire thing.Â
Any tips are appreciated!Â
Thanks
Hallie Bourne
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
