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.
Re: Document Revision History - Front or Back of the Doc?
Subject:Re: Document Revision History - Front or Back of the Doc? From:Matthew Helmke <matthew -at- matthewhelmke -dot- com> To:"techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 17 Jul 2012 12:55:40 -0500
Where I work now, we put it at the front. In other projects that I have
worked on, it was at the back. I don't think there is a definitive "this is
the best way." As long as your readers know how to find the information,
either is acceptable.
On Tue, Jul 17, 2012 at 12:52 PM, Ron Hearn <rhearn -at- central1 -dot- com> wrote:
> Hi folks,
>
> I have been placing the document revision history for a document as part
> of the preface in my documentation. Someone suggested that it should be
> located at the end of the document. I am just wondering where other TWs
> place this part of the document.
>
> Regards,
>
> Ron Hearn
> Documentation Specialist
>
> Central 1 Credit Union
> 1441 Creekside Drive
> Vancouver, British Columbia, Canada
> V6J 4S7
>
> rhearn -at- central1 -dot- com<mailto:rhearn -at- central1 -dot- com>
> Tel: 604.730.6391
> Fax: 604.730-7792
> www.central1.com/thinkingforward<http://www.central1.com/thinkingforward>
>
>
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 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://bit.ly/doc-to-help
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as matthew -at- matthewhelmke -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> 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
>
--
Matthew Helmke
matthew -at- matthewhelmke -dot- com
Author of Ubuntu Unleashed, Humor and Moroccan Culture, and Nowhere Else to
Turn
Coauthor of VMware Cookbook and The Official Ubuntu Book
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.