need help selecting doc tools
Hello all: I am starting a new venture on Monday at a startup company that has never had a tech writer and needs me to write all the doc from scratch. I've been using FrameMaker 6.0 for several years now with WebWorks Professional 2003. My new boss (VP of Engineering) has asked me to put together a doc tools strategy plan for design and delivery for the technical documentation. Being a startup, my budget will be fairly low so content management systems are not an option at this point. I've been doing research over the past week and it's been a daunting process. What I'm thinking of purchasing is FrameMaker 7.2 and using it's structured capabilities. For HTML generation, I'm considering WebWorks ePublisher Pro. Is anyone using these two products together (and if so, could you share your thoughts). I'd also appreciate advise on other options. I'm thinking that I'll need training to get up and running, so if anyone can recommend trainers in the Massachusetts/NH/RI areas that would also be helpful. Thanks for your assistance, Aaron
need help selecting doc tools
Documentation is usually a two-phase effort -- authoring and then delivering. So you actually need two shopping lists, one for each stage. For authoring, FM is a safe environment that's open-ended for final deliverables. What I'd be more concerned about than delivery at this point is the graphic side of authoring. So Adobe's Creative Suite Pro would be on my "early" shopping list. For delivery, I think that until you know your audience and output formats, and what your competition does, picking tools to form the deliverable may be premature, so I'd be tempted to hold off on the WebWorks until I had more answers. Same thing on structure. Whether or not you'd need/use the structured environment is also something I'd research more in depth before committing to at the beginning. You're going to get more points for finding out the needs and requirements of the job before putting together your final shopping list than you are for possibly buying the wrong tools quickly. Art On 4/14/07, Aaron Bennett wrote: > Hello all: > > I am starting a new venture on Monday at a startup company that has never > had a tech writer and needs me to write all the doc from scratch. I've been > using FrameMaker 6.0 for several years now with WebWorks Professional 2003. > My new boss (VP of Engineering) has asked me to put together a doc tools > strategy plan for design and delivery for the technical documentation. > > Being a startup, my budget will be fairly low so content management systems > are not an option at this point. I've been doing research over the past > week and it's been a daunting process. What I'm thinking of purchasing is > FrameMaker 7.2 and using it's structured capabilities. For HTML generation, > I'm considering WebWorks ePublisher Pro. Is anyone using these two products > together (and if so, could you share your thoughts). I'd also appreciate > advise on other options. > > I'm thinking that I'll need training to get up and running, so if anyone can > recommend trainers in the Massachusetts/NH/RI areas that would also be > helpful. > > Thanks for your assistance, > > Aaron -- Art Campbell art.campbell at gmail.com "... In my opinion, there's nothing in this world beats a '52 Vincent and a redheaded girl." -- Richard Thompson No disclaimers apply. DoD 358
need help selecting doc tools
Hi Aaron... FrameMaker and WebWorks are a very good combination, and would most likely do what's needed. However, you might want to get more clarification on how the source documentation may be integrated into the development environment as well as what types of output are expected and how that output is to be integrated into the shipping product. Being in the unique situation of setting things up, as you are, it's worth taking some extra time to make sure that the tools you choose will really provide the solution. Something that you may want to look into is using DITA as your underlying data model (if you're entertaining the idea of using structured authoring). One of the biggest problems that people have in using DITA is the migration of legacy content .. you don't have this problem. If the focus of your output is to online Help or web delivery, DITA's topic-oriented focus may be ideal. One of the benefits of using DITA is that through the OpenToolkit (free open source set of tools), you get all you need to generate various forms of online output (no WebWorks required). (Caveat: you will need to spend time/money modifying the XSLT transformations to get the output to look the way you want, but perhaps you've got some XSLT developers on staff(?).) Also, because DITA is XML, you can easily integrate (both in and out) with code in your development stream. If you're really on a tight budget, you could also forgo using FrameMaker and just use an XML editor (you do want to make sure that it really supports DITA in a useful way). This may be more than you really want to deal with, but it's probably worth looking into. For more info visit the following URL .. http://dita.xml.org/introduction Good luck! ...scott Scott Prentice Leximation, Inc. www.leximation.com +1.415.485.1892 Aaron Bennett wrote: > Hello all: > > I am starting a new venture on Monday at a startup company that has never > had a tech writer and needs me to write all the doc from scratch. > I've been > using FrameMaker 6.0 for several years now with WebWorks Professional > 2003. > My new boss (VP of Engineering) has asked me to put together a doc tools > strategy plan for design and delivery for the technical documentation. > > Being a startup, my budget will be fairly low so content management > systems > are not an option at this point. I've been doing research over the past > week and it's been a daunting process. What I'm thinking of > purchasing is > FrameMaker 7.2 and using it's structured capabilities. For HTML > generation, > I'm considering WebWorks ePublisher Pro. Is anyone using these two > products > together (and if so, could you share your thoughts). I'd also appreciate > advise on other options. > > I'm thinking that I'll need training to get up and running, so if > anyone can > recommend trainers in the Massachusetts/NH/RI areas that would also be > helpful. > > Thanks for your assistance, > > Aaron > > > > >
need help selecting doc tools
It was written: > Something that you may want to look into is using DITA as your > underlying data model (if you're entertaining the idea of using > structured authoring). One of the biggest problems that people have in > using DITA is the migration of legacy content .. you don't have this > problem. The same logic holds for creating a dataset using a more descriptive structure, so why only go halfway? Why not design a structure that fully describes the data? > If the focus of your output is to online Help or web delivery, > DITA's topic-oriented focus may be ideal. One of the benefits of using > DITA is that through the OpenToolkit (free open source set of tools), > you get all you need to generate various forms of online output (no > WebWorks required). (Caveat: you will need to spend time/money modifying > the XSLT transformations to get the output to look the way you want, but > perhaps you've got some XSLT developers on staff(?).) If you have XSLT developers on staff, you can create the outputs from any XML, though it may be more work than using the toolkit. (I don't have any experience with it.) > Also, because DITA is XML, you can easily integrate (both in and out) > with code in your development stream. The same applies for any XML structure. > If you're really on a tight budget, you could also forgo using > FrameMaker and just use an XML editor... As above - the same applies for any XML. Although I'm yet to find it, I'm sure that DITA has its place. Recommending for a green-fields scenario where the opportunity exists to put a startup on a good footing smacks of lost potential to me though. My advice for the original poster would be to forget the budget for tools - sort out the strategy for data management over the foreseeable future and then try to establish what you will require to support it. If you choose tools first, you'll design a data strategy that suits your choices, not one that serves your dataset. -- Regards, Marcus Carr email: mcarr at allette.com.au ___ Allette Systems (Australia) www:http://www.allette.com.au ___ "Everything should be made as simple as possible, but not simpler." - Einstein
need help selecting doc tools
Aaron, Have you posted this question anywhere else? To a "non" FrameMaker list for example (TechWR?). Just a thought. As others have said, I'd want to know more about what outputs were required, how often you have to build them, and what the usage of the docs will be. FrameMaker + WWP is a good package but depending on your needs there are better ones out there. Gordon -Original Message- Subject: need help selecting doc tools Hello all: I am starting a new venture on Monday at a startup company that has never had a tech writer and needs me to write all the doc from scratch. I've been using FrameMaker 6.0 for several years now with WebWorks Professional 2003. My new boss (VP of Engineering) has asked me to put together a doc tools strategy plan for design and delivery for the technical documentation. This email (and any attachments) is private and confidential, and is intended solely for the addressee. If you have received this communication in error please remove it and inform us via telephone or email. Although we take all possible steps to ensure mail and attachments are free from malicious content, malware and viruses, we cannot accept any responsibility whatsoever for any changes to content outwith our administrative bounds. The views represented within this mail are solely the view of the author and do not reflect the views of the organisation as a whole. Graham Technology plc Registered in Scotland company no. SC143434 Registered Office India of Inchinnan, Renfrewshire, Scotland PA4 9LH http://www.grahamtechnology.com
need help selecting doc tools
Hello all: I am starting a new venture on Monday at a startup company that has never had a tech writer and needs me to write all the doc from scratch. I've been using FrameMaker 6.0 for several years now with WebWorks Professional 2003. My new boss (VP of Engineering) has asked me to put together a doc tools strategy plan for design and delivery for the technical documentation. Being a startup, my budget will be fairly low so content management systems are not an option at this point. I've been doing research over the past week and it's been a daunting process. What I'm thinking of purchasing is FrameMaker 7.2 and using it's structured capabilities. For HTML generation, I'm considering WebWorks ePublisher Pro. Is anyone using these two products together (and if so, could you share your thoughts). I'd also appreciate advise on other options. I'm thinking that I'll need training to get up and running, so if anyone can recommend trainers in the Massachusetts/NH/RI areas that would also be helpful. Thanks for your assistance, Aaron ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: need help selecting doc tools
Documentation is usually a two-phase effort -- authoring and then delivering. So you actually need two shopping lists, one for each stage. For authoring, FM is a safe environment that's open-ended for final deliverables. What I'd be more concerned about than delivery at this point is the graphic side of authoring. So Adobe's Creative Suite Pro would be on my "early" shopping list. For delivery, I think that until you know your audience and output formats, and what your competition does, picking tools to form the deliverable may be premature, so I'd be tempted to hold off on the WebWorks until I had more answers. Same thing on structure. Whether or not you'd need/use the structured environment is also something I'd research more in depth before committing to at the beginning. You're going to get more points for finding out the needs and requirements of the job before putting together your final shopping list than you are for possibly buying the wrong tools quickly. Art On 4/14/07, Aaron Bennett <[EMAIL PROTECTED]> wrote: Hello all: I am starting a new venture on Monday at a startup company that has never had a tech writer and needs me to write all the doc from scratch. I've been using FrameMaker 6.0 for several years now with WebWorks Professional 2003. My new boss (VP of Engineering) has asked me to put together a doc tools strategy plan for design and delivery for the technical documentation. Being a startup, my budget will be fairly low so content management systems are not an option at this point. I've been doing research over the past week and it's been a daunting process. What I'm thinking of purchasing is FrameMaker 7.2 and using it's structured capabilities. For HTML generation, I'm considering WebWorks ePublisher Pro. Is anyone using these two products together (and if so, could you share your thoughts). I'd also appreciate advise on other options. I'm thinking that I'll need training to get up and running, so if anyone can recommend trainers in the Massachusetts/NH/RI areas that would also be helpful. Thanks for your assistance, Aaron -- Art Campbell [EMAIL PROTECTED] "... In my opinion, there's nothing in this world beats a '52 Vincent and a redheaded girl." -- Richard Thompson No disclaimers apply. DoD 358 ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: need help selecting doc tools
Hi Aaron... FrameMaker and WebWorks are a very good combination, and would most likely do what's needed. However, you might want to get more clarification on how the source documentation may be integrated into the development environment as well as what types of output are expected and how that output is to be integrated into the shipping product. Being in the unique situation of setting things up, as you are, it's worth taking some extra time to make sure that the tools you choose will really provide the solution. Something that you may want to look into is using DITA as your underlying data model (if you're entertaining the idea of using structured authoring). One of the biggest problems that people have in using DITA is the migration of legacy content .. you don't have this problem. If the focus of your output is to online Help or web delivery, DITA's topic-oriented focus may be ideal. One of the benefits of using DITA is that through the OpenToolkit (free open source set of tools), you get all you need to generate various forms of online output (no WebWorks required). (Caveat: you will need to spend time/money modifying the XSLT transformations to get the output to look the way you want, but perhaps you've got some XSLT developers on staff(?).) Also, because DITA is XML, you can easily integrate (both in and out) with code in your development stream. If you're really on a tight budget, you could also forgo using FrameMaker and just use an XML editor (you do want to make sure that it really supports DITA in a useful way). This may be more than you really want to deal with, but it's probably worth looking into. For more info visit the following URL .. http://dita.xml.org/introduction Good luck! ...scott Scott Prentice Leximation, Inc. www.leximation.com +1.415.485.1892 Aaron Bennett wrote: Hello all: I am starting a new venture on Monday at a startup company that has never had a tech writer and needs me to write all the doc from scratch. I've been using FrameMaker 6.0 for several years now with WebWorks Professional 2003. My new boss (VP of Engineering) has asked me to put together a doc tools strategy plan for design and delivery for the technical documentation. Being a startup, my budget will be fairly low so content management systems are not an option at this point. I've been doing research over the past week and it's been a daunting process. What I'm thinking of purchasing is FrameMaker 7.2 and using it's structured capabilities. For HTML generation, I'm considering WebWorks ePublisher Pro. Is anyone using these two products together (and if so, could you share your thoughts). I'd also appreciate advise on other options. I'm thinking that I'll need training to get up and running, so if anyone can recommend trainers in the Massachusetts/NH/RI areas that would also be helpful. Thanks for your assistance, Aaron ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: need help selecting doc tools
It was written: Something that you may want to look into is using DITA as your underlying data model (if you're entertaining the idea of using structured authoring). One of the biggest problems that people have in using DITA is the migration of legacy content .. you don't have this problem. The same logic holds for creating a dataset using a more descriptive structure, so why only go halfway? Why not design a structure that fully describes the data? If the focus of your output is to online Help or web delivery, DITA's topic-oriented focus may be ideal. One of the benefits of using DITA is that through the OpenToolkit (free open source set of tools), you get all you need to generate various forms of online output (no WebWorks required). (Caveat: you will need to spend time/money modifying the XSLT transformations to get the output to look the way you want, but perhaps you've got some XSLT developers on staff(?).) If you have XSLT developers on staff, you can create the outputs from any XML, though it may be more work than using the toolkit. (I don't have any experience with it.) Also, because DITA is XML, you can easily integrate (both in and out) with code in your development stream. The same applies for any XML structure. If you're really on a tight budget, you could also forgo using FrameMaker and just use an XML editor... As above - the same applies for any XML. Although I'm yet to find it, I'm sure that DITA has its place. Recommending for a green-fields scenario where the opportunity exists to put a startup on a good footing smacks of lost potential to me though. My advice for the original poster would be to forget the budget for tools - sort out the strategy for data management over the foreseeable future and then try to establish what you will require to support it. If you choose tools first, you'll design a data strategy that suits your choices, not one that serves your dataset. -- Regards, Marcus Carr email: [EMAIL PROTECTED] ___ Allette Systems (Australia) www:http://www.allette.com.au ___ "Everything should be made as simple as possible, but not simpler." - Einstein ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: need help selecting doc tools
Aaron, Have you posted this question anywhere else? To a "non" FrameMaker list for example (TechWR?). Just a thought. As others have said, I'd want to know more about what outputs were required, how often you have to build them, and what the usage of the docs will be. FrameMaker + WWP is a good package but depending on your needs there are better ones out there. Gordon -Original Message- Subject: need help selecting doc tools Hello all: I am starting a new venture on Monday at a startup company that has never had a tech writer and needs me to write all the doc from scratch. I've been using FrameMaker 6.0 for several years now with WebWorks Professional 2003. My new boss (VP of Engineering) has asked me to put together a doc tools strategy plan for design and delivery for the technical documentation. This email (and any attachments) is private and confidential, and is intended solely for the addressee. If you have received this communication in error please remove it and inform us via telephone or email. Although we take all possible steps to ensure mail and attachments are free from malicious content, malware and viruses, we cannot accept any responsibility whatsoever for any changes to content outwith our administrative bounds. The views represented within this mail are solely the view of the author and do not reflect the views of the organisation as a whole. Graham Technology plc Registered in Scotland company no. SC143434 Registered Office India of Inchinnan, Renfrewshire, Scotland PA4 9LH http://www.grahamtechnology.com ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.