atw: Re: managing, storing and distributing internal documentation

RoboHelp 7 has version control features which might be useful if you need to
keep track of changes to your Intranet. A simple way, however, to maintain
copies of previous Intranet builds is to zip the files using tools such as
WinZip.
As for RoboHelp documentation, I can only suggest the RoboHelp site, itself.


Cheers

> -----Original Message-----
> From: nigeldawes [mailto:nigel@xxxxxxxxxxxxxxx]
> Sent: 01 February 2005 10:53
> To: austechwriter@xxxxxxxxxxxxx
> Subject: atw: Re: managing, storing and distributing internal
> documentation
> 
> 
> Thanks Paul.
> I currently use RoboHelp X5 Office, but I'm still
> finding my feet.
> 
> To follow your advice, do I need to upgrade to the
> Enterprise package?
> 
> Regards
> Nigel
> 
> P.S. While on the topic of RoboHelp, can you suggest
> any appropriate reading I might find useful?
> 
> 
> 
> -----Original Message-----
> From: austechwriter-bounce@xxxxxxxxxxxxx
> [mailto:austechwriter-bounce@xxxxxxxxxxxxx]On Behalf Of
> Paul Birkwood
> Sent: Tuesday, 1 February 2005 11:23 AM
> To: austechwriter@xxxxxxxxxxxxx
> Subject: atw: Re: managing, storing and distributing
> internal
> documentation
> 
> 
> Hi Nigel,
> I used RoboHelp to build an Intranet web site. Together
> with a carefully
> structured directory system to store documents under
> products/projects
> titles, it is a simple system for facilitating user
> access to
> documentation. Each document directory, for example,
> has subdirectories
> for holding drafts, published copies, source material,
> and zipped backups.
> Using http: addresses, I can build read-only links to
> the directories.
> 
> This system suits me because I'm the only one creating
> user documentation.
> If you are also including development documentation
> written by other
> authors (which I also must accommodate), you will need
> to control the way
> in which documents enter the directory system. Ideally,
> if you have a
> document numbering system, then the number becomes a
> subdirectory name.
> 
> Sample hierarchy
> 
> ../Intranet
> .../Intranet/ProjectX
> .../Intranet/ProjectX/<Document No.>
> .../Intranet/ProjectX/<Document No.>/Drafts
> .../Intranet/ProjectX/<Document No.>/Published
> .../Intranet/ProjectX/<Document No.>/ZippedRevisions
> .../Intranet/ProjectX/<Document No.>/WebHelp
> 
> In this system, you can also include revision numbers
> or letters to
> maintain major revisions. 
> 
> You then can keep PDFs in Drafts, finally placing the
> final published copy
> in the /Published subdirectory. You can just allow
> users to browse the
> hyperlinked directories or you can set up web pages
> with hyperlinks to the
> files.
> 
> Hope this helps.
> 
> Cheers
> 
> > -----Original Message-----
> > From: nigeldawes [mailto:nigel@xxxxxxxxxxxxxxx]
> > Sent: 01 February 2005 09:41
> > To: austechwriter@xxxxxxxxxxxxx
> > Subject: atw: managing, storing and distributing
> internal documentation
> > 
> > 
> > Dear Austechies
> > 
> > I've been tasked with developing and implementing a
> > strategy for managing, storing and distributing our
> > internal documentation using the Intranet Web server,
> > which I access using use Timbuktu.
> > 
> > Currently, navigating the document pages is quite
> ugly,
> > as the interface uses basic hyperlink menus and is
> > rather disorganised. I don't have the resources to
> buy
> > fancy new software, so must develop a strategy for
> > organising, managing and controlling all this
> disparate
> > documentation using the current resources.
> > 
> > Currently, each department maintains its own
> directory,
> > which has resulted in the directory structures being
> > very dissimilar. I thought the obvious answer is to
> > declare a single point of contact (I guess that's
> going
> > to be me!), who would be responsible for posting all
> > docs.
> > 
> > I'm sure plenty of you have been through this before
> > and would love to hear about your success, failures,
> > suggestions etc... etc.
> > 
> > Friendly Regards
> > Nigel
> > 
> > ___________
> > Nigel Dawes
> > Technical Writer
> > 
> > Quickcut Limited
> > Adv. Development Group
> > 15-17 Old Pittwater Rd
> > Brookvale   NSW   2100
> > T: +61 (0) 2 9938 7558
> > F: +61 (0) 2 9938 7555
> > 
> > 
> > 
> > Disclaimer:
> > By sending an email to ANY of my addresses, you are
> > agreeing that:
> > 
> > 1. I am by definition, "the intended recipient".
> > 2. All information in the email is mine to do with as
> I
> > see fit and make such financial profit, political
> > mileage, or good joke as it lends itself to. In
> > particular, I may quote it on UseNet.
> > 3. I may take the contents as representing the views
> of
> > your company.
> > 4. This overrides any disclaimer or statement of
> > confidentiality that may be included on your message.
> > 
> > 
> > 
> > 
> > **************************************************
> > To post a message to austechwriter, send the message
> to 
> > austechwriter@xxxxxxxxxxxxxx
> > 
> > To subscribe to austechwriter, send a message to 
> > austechwriter-request@xxxxxxxxxxxxx with "subscribe"
> in the Subject
> field.
> > 
> > To unsubscribe, send a message to 
> > austechwriter-request@xxxxxxxxxxxxx with
> "unsubscribe" in the 
> > Subject field.
> > 
> > To search the austechwriter archives, go to 
> www.freelists.org/archives/austechwriter
> 
> To contact the list administrator, send a message to
> austechwriter-admins@xxxxxxxxxxxxx
> **************************************************
> 
> -------------------------------------------------------
> -------------
> CAUTION: This email and any attachments may contain
> information that is
> confidential and subject to copyright. If you are not
> the intended
> recipient, you must not read, use, disseminate,
> distribute or copy this
> email or any attachments. If you have received this
> email in error, please
> notify the sender immediately by reply email and erase
> this email and any
> attachments. Thank you.
> DISCLAIMER: To the maximum extent permitted by law,
> Pracom Limited is not
> liable (including in respect of negligence) for viruses
> or other defects
> or for changes made to this email or to any
> attachments. Before opening or
> using attachments, please check them for viruses and
> other effects. If
> this email is a private communication it may not
> represent the views of
> Pracom Limited.
> -------------------------------------------------------
> -------------
> 
> 
> -- Binary/unsupported file stripped by Ecartis --
> -- Type: application/ms-tnef
> -- File: winmail.dat
> 
> 
> **************************************************
> To post a message to austechwriter, send the message to
> austechwriter@xxxxxxxxxxxxxx
> 
> To subscribe to austechwriter, send a message to
> austechwriter-request@xxxxxxxxxxxxx with "subscribe" in
> the Subject field.
> 
> To unsubscribe, send a message to
> austechwriter-request@xxxxxxxxxxxxx with "unsubscribe"
> in the Subject field.
> 
> To search the austechwriter archives, go to
> www.freelists.org/archives/austechwriter
> 
> To contact the list administrator, send a message to
> austechwriter-admins@xxxxxxxxxxxxx
> **************************************************
> 
> 
> -- Binary/unsupported file stripped by Ecartis --
> -- Type: application/ms-tnef
> -- File: winmail.dat
> 
> 
> **************************************************
> To post a message to austechwriter, send the message to 
> austechwriter@xxxxxxxxxxxxxx
> 
> To subscribe to austechwriter, send a message to 
> austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject field.
> 
> To unsubscribe, send a message to 
> austechwriter-request@xxxxxxxxxxxxx with "unsubscribe" in the 
> Subject field.
> 
> To search the austechwriter archives, go to 
> www.freelists.org/archives/austechwriter
> 
> To contact the list administrator, send a message to 
> austechwriter-admins@xxxxxxxxxxxxx
> **************************************************
> 
> --------------------------------------------------------------------
> CAUTION: This email and any attachments may contain information 
> that is confidential and subject to copyright. If you are not the 
> intended recipient, you must not read, use, disseminate, 
> distribute or copy this email or any attachments. If you have 
> received this email in error, please notify the sender 
> immediately by reply email and erase this email and any 
> attachments. Thank you.
> DISCLAIMER: To the maximum extent permitted by law, Pracom 
> Limited is not liable (including in respect of negligence) for 
> viruses or other defects or for changes made to this email or to 
> any attachments. Before opening or using attachments, please 
> check them for viruses and other effects. If this email is a 
> private communication it may not represent the views of Pracom Limited.
> --------------------------------------------------------------------
> 

-- Binary/unsupported file stripped by Ecartis --
-- Type: application/ms-tnef
-- File: winmail.dat


**************************************************
To post a message to austechwriter, send the message to 
austechwriter@xxxxxxxxxxxxxx

To subscribe to austechwriter, send a message to 
austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject field.

To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx with 
"unsubscribe" in the Subject field.

To search the austechwriter archives, go to 
www.freelists.org/archives/austechwriter

To contact the list administrator, send a message to 
austechwriter-admins@xxxxxxxxxxxxx
**************************************************

Other related posts: