RE: Example of a good Accessory User Guide
Thanks for the advice Craig and Allison, Much appreciated. Denis From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Craig Ede Sent: 18 April 2015 20:32 To: framers Subject: RE: Example of a good Accessory User Guide To add to what I said earlier, I'd say don't be specific about the samples you want, and assume that any single sample will be a subset of what is needed in the template. Ask for a group of samples that demonstrate the range of things that are desired and then expect there to be things that are missed in that set of samples. Creating a template is an iterative process. Craig ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: Example of a good Accessory User Guide
I've done three major redesigns of my template in 18 months as the scope of the documentation has expanded. My last redesign was to accommodate the document set going global. John X Posada AML Syst Ops Supt Data Analyst | US FCC RC Systems Control Analytics | HSBC North America Holdings Inc 330 Madison Ave., NY NY ___ Phone Int: 212-525-5483 Ext: Personal Cellphone - 732-259-2874 Fax Conference Bridge - 877-304-0052, Code 74809254 Email john.x.pos...@us.hsbc.com ___ Protect our environment - please only print this if you have to! From: Craig Ede craig...@hotmail.com To: framers framers@lists.frameusers.com Date: 04/18/2015 03:34 PM Subject:RE: Example of a good Accessory User Guide Sent by:framers-boun...@lists.frameusers.com To add to what I said earlier, I'd say don't be specific about the samples you want, and assume that any single sample will be a subset of what is needed in the template. Ask for a group of samples that demonstrate the range of things that are desired and then expect there to be things that are missed in that set of samples. Creating a template is an iterative process. Craig ** This message originated from the Internet. Its originator may or may not be who they claim to be and the information contained in the message and any attachments may or may not be accurate. ** ___ You are currently subscribed to framers as john.x.pos...@us.hsbc.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/john.x.posada%40us.hsbc.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info. ** This message originated from the Internet. Its originator may or may not be who they claim to be and the information contained in the message and any attachments may or may not be accurate. ** - ** This E-mail is confidential. It may also be legally privileged. If you are not the addressee you may not copy, forward, disclose or use any part of it. If you have received this message in error, please delete it and all copies from your system and notify the sender immediately by return E-mail. Internet communications cannot be guaranteed to be timely, secure, error or virus-free. The sender does not accept liability for any errors or omissions. ** SAVE PAPER - THINK BEFORE YOU PRINT! ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: Example of a good Accessory User Guide
To add to what I said earlier, I'd say don't be specific about the samples you want, and assume that any single sample will be a subset of what is needed in the template. Ask for a group of samples that demonstrate the range of things that are desired and then expect there to be things that are missed in that set of samples. Creating a template is an iterative process. Craig ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Example of a good Accessory User Guide
Hi, Would anyone have a good example of an effective template of a user guide for an accessory, please? I am looking for an optimum layout which conveys succinctly the instructions for using the accessory. Maybe one of 5 pages. Looking online, there are many different layouts; just wondering if someone has already been down this road and has any advice? Kind regards, Denis Daly Technical Writer [ICPNT Simple Logo White - Small] Kilbrittain, Bandon, Co. Cork, IRELANDhttp://www.myloc8ion.com/index.php/maps/find_code8/?code=WLF-17-68G Mobile: +353 86 3539962 Phone: +353 21 2439119/140 Fax: +353 21 2380559 Info: www.icpnewtech.comhttp://www.icpnewtech.com/ ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Re: Example of a good Accessory User Guide
At 09:19 + 17/4/15, Denis Daly wrote: Would anyone have a good example of an effective template of a user guide for an accessory, please? Without meaning to be critical, Denis, your question isn't really answerable as it stands. What sort of accessory, and for what? Is there anything on the thing for which the accessory is an accessory for? Do you need to match that? Looking at your company's website, it seems that you are involved in ordnance detection and disposal. That's a pretty specialized and technical field and would, I imagine, involve many legal requirements for hazmat warnings and so forth. Doesn't your company have an already-defined set of documentation guidelines, look-and-feel and/or templates? If you can provide more details, maybe someone on this list can give you some leads. Aside from that, unstructured FrameMaker template construction isn't hard, but if you want to start with something that will stand the test of time you might consider involving a document designer. It's a big field, which starts with the document end-users' requirements, delivery media and so on. -- Steve ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: Example of a good Accessory User Guide
Understood Steve, Please ignore. I need to think more about it myself. Thanks... -Original Message- From: Steve Rickaby [mailto:srick...@wordmongers.demon.co.uk] Sent: 17 April 2015 10:53 To: Denis Daly Cc: framers@lists.frameusers.com Subject: Re: Example of a good Accessory User Guide At 09:19 + 17/4/15, Denis Daly wrote: Would anyone have a good example of an effective template of a user guide for an accessory, please? Without meaning to be critical, Denis, your question isn't really answerable as it stands. What sort of accessory, and for what? Is there anything on the thing for which the accessory is an accessory for? Do you need to match that? Looking at your company's website, it seems that you are involved in ordnance detection and disposal. That's a pretty specialized and technical field and would, I imagine, involve many legal requirements for hazmat warnings and so forth. Doesn't your company have an already-defined set of documentation guidelines, look-and-feel and/or templates? If you can provide more details, maybe someone on this list can give you some leads. Aside from that, unstructured FrameMaker template construction isn't hard, but if you want to start with something that will stand the test of time you might consider involving a document designer. It's a big field, which starts with the document end-users' requirements, delivery media and so on. -- Steve ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: Example of a good Accessory User Guide
Get a consensus on a sample from your organization that already exists and everyone likes, then create one yourself to replicate that template in FM. Shouldn't take more than a couple of days, including master page, reference page, and Char Para styles . I did that when I got to this bank and now all my documentation (1500-2500 pages per month..I have a team of 8 contributors) look just like the documentation that everyone else in Word is creating. John X Posada AML Syst Ops Supt Data Analyst | US FCC RC Systems Control Analytics | HSBC North America Holdings Inc 330 Madison Ave., NY NY ___ Phone Int: 212-525-5483 Ext: Personal Cellphone - 732-259-2874 Fax Conference Bridge - 877-304-0052, Code 74809254 Email john.x.pos...@us.hsbc.com ___ Protect our environment - please only print this if you have to! From: Denis Daly d.d...@icpnewtech.com To: Steve Rickaby srick...@wordmongers.demon.co.uk Cc: framers@lists.frameusers.com framers@lists.frameusers.com Date: 04/17/2015 07:10 AM Subject:RE: Example of a good Accessory User Guide Sent by:framers-boun...@lists.frameusers.com Understood Steve, Please ignore. I need to think more about it myself. Thanks... -Original Message- From: Steve Rickaby [mailto:srick...@wordmongers.demon.co.uk] Sent: 17 April 2015 10:53 To: Denis Daly Cc: framers@lists.frameusers.com Subject: Re: Example of a good Accessory User Guide At 09:19 + 17/4/15, Denis Daly wrote: Would anyone have a good example of an effective template of a user guide for an accessory, please? Without meaning to be critical, Denis, your question isn't really answerable as it stands. What sort of accessory, and for what? Is there anything on the thing for which the accessory is an accessory for? Do you need to match that? Looking at your company's website, it seems that you are involved in ordnance detection and disposal. That's a pretty specialized and technical field and would, I imagine, involve many legal requirements for hazmat warnings and so forth. Doesn't your company have an already-defined set of documentation guidelines, look-and-feel and/or templates? If you can provide more details, maybe someone on this list can give you some leads. Aside from that, unstructured FrameMaker template construction isn't hard, but if you want to start with something that will stand the test of time you might consider involving a document designer. It's a big field, which starts with the document end-users' requirements, delivery media and so on. -- Steve ___ You are currently subscribed to framers as john.x.pos...@us.hsbc.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/john.x.posada%40us.hsbc.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info. ** This message originated from the Internet. Its originator may or may not be who they claim to be and the information contained in the message and any attachments may or may not be accurate. ** - ** This E-mail is confidential. It may also be legally privileged. If you are not the addressee you may not copy, forward, disclose or use any part of it. If you have received this message in error, please delete it and all copies from your system and notify the sender immediately by return E-mail. Internet communications cannot be guaranteed to be timely, secure, error or virus-free. The sender does not accept liability for any errors or omissions. ** SAVE PAPER - THINK BEFORE YOU PRINT
RE: Example of a good Accessory User Guide
I second John's advice. You have to have a very good idea of how to set up a template to do it efficiently, but that's is the best way to go. Craig Subject: RE: Example of a good Accessory User Guide To: d.d...@icpnewtech.com From: john.x.pos...@us.hsbc.com Date: Fri, 17 Apr 2015 10:31:52 -0400 CC: framers@lists.frameusers.com Get a consensus on a sample from your organization that already exists and everyone likes, then create one yourself to replicate that template in FM. ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
