[Framers] Question About Revision History.

[Lin Sims]

One of my former employers used it as a way to let readers know how
information had changed because the document was very long and very
technical (installing enterprise-level software). I'm not sure how much it
helped overall, but at least if, say, what was required of the customer to
have for hardware or already-installed software had changed, they had an
alert to pay extra attention to that. Or if how outside-party software had
to be configured to work with our software changed, they'd have an alert on
that, too.

We used change bars in the text itself, but that didn't tell customers HOW
things had changed, only that they had. The revision history told them how,
which told them what to pay attention to.

On Tue, Nov 26, 2019 at 11:50 AM <ian.proudfoot at itp-x.co.uk> wrote:

> Rick,
> Revision history is often more of a regulatory requirement than a
> nice-to-have feature. If there are no external rules that say you must have
> it, then what purpose would it serve? Maybe just to show that the document
> does get updated from time-to-time?
>
> Ian Proudfoot
>
>
>
>
> -----Original Message-----
> From: Framers <framers-bounces+ian.proudfoot=
> itp-x.co.uk at lists.frameusers.com> On Behalf Of Richard Melanson
> Sent: 26 November 2019 16:20
> To: An email list for people using Adobe FrameMaker software. <
> framers at lists.frameusers.com>
> Subject: [Framers] Question About Revision History.
>
> Somewhat off topic, what does everyone think about not having a revision
> history in user manuals. My company has decided they do not want this in
> any customer facing docs.
>
> Thank you for your replies.
>
> Rick
>
> Richard Melanson
> Technical Writer|HighRes Biosolutions
> T:781.932.1912x1160|rmelanson at highresbio.com
> www.highresbio.com
>
> This e-mail message may contain confidential information and may not be
> used by anyone but the intended recipient.  If you are not the intended
> recipient, you are hereby notified that any use or dissemination of this
> message is strictly prohibited. If you received this message in error,
> please notify HighRes Biosolutions immediately by reply email.  Then delete
> this message from your system.  Thank you.
> _______________________________________________
>
> This message is from the Framers mailing list
>
> Send messages to framers at lists.frameusers.com Visit the list's homepage
> at  http://www.frameusers.com Archives located at
> http://www.mail-archive.com/framers%40lists.frameusers.com/
> Subscribe and unsubscribe at
> http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
> Send administrative questions to listadmin at frameusers.com
>
> _______________________________________________
>
> This message is from the Framers mailing list
>
> Send messages to framers at lists.frameusers.com
> Visit the list's homepage at  http://www.frameusers.com
> Archives located at
> http://www.mail-archive.com/framers%40lists.frameusers.com/
> Subscribe and unsubscribe at
> http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
> Send administrative questions to listadmin at frameusers.com
>


-- 
Lin Sims