Re: [TCP] Domain knowledge
I agree almost entirely with Bill. I would add one precaution. Bill wrote: 3. Do you think that the future is bright for specialist technical communicators, rather than generalists? Always has been, always will be. To which I add, it's possible to overspecialize. Don't become so specialized that you can't adapt to changing markets. Tom Johnson 231-944-7454 tajohn...@microlinetc.com -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of Bill Swallow Sent: Monday, May 10, 2010 9:16 AM To: Vishnu Cc: tcp@techcommpros.com Subject: Re: [TCP] Domain knowledge 1. How much domain knowledge should a user have while using a software? For example, if it is a banking application, will domain knowledge help the user in finishing tasks? Given that software is simply a tool for getting a job done, users should have as much domain knowledge as possible. Would you trust a handyman to use a banking application to manage your bank accounts, or would you rather trust a banker with that task? 2. How much of these domain knowledge should go into a user manual? Will users benefit if the business context or logic is described in detail in a manual? Or will the user more interested in finishing a task, rather than reading the context and other things? It depends on the audience, application, subject matter, and purpose. -- Bill Swallow Twitter: @techcommdood Blog: http://techcommdood.com LinkedIn: http://www.linkedin.com/in/techcommdood Available for contract and full time opportunities. __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] Technical writing and tools
Dana, I appreciate you pointing out the importance of ethical behavior. Ethical behavior is important and my advice crossed the line. By implying the inclusion of random characters was something that I might choose to do, rather than an unavoidable feature of a trial version, I conveyed a wrong and misleading context. That could indeed get you into trouble. Here's my new advice. Buy legitimate copies of software and become a power user, produce excellent samples and you have your in with prospective employers. Now that I think through the issue a little more, could using those samples as part of a portfolio--with or without random characters--be considered unethical? Would using materials produced with trial software for a tangible project such as a portfolio piece go beyond the purpose of the trial software? Is using trial software to solely enhance your skills outside the realm of fair use? Presumably, Madcap is okay with whatever work you produce during an evaluation period as long as you buy the software after the evaluation period because purchased copies of Madcap's software will strip out the random characters. It's just something to think about. Tom Johnson 231-944-7454 tajohn...@microlinetc.com -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of Dana Worley Sent: Wednesday, April 28, 2010 12:19 PM To: tcp@techcommpros.com Subject: Re: [TCP] Technical writing and tools On Wednesday, April 28, 2010, Thomas Johnson wrote: An alternative would be to include a disclaimer stating that the random characters are included to discourage unauthorized re-use of your samples. I'd avoid that situation if possible. I agree with most of Tom's comments. Think about it, if my developers code our applications in C++ and I am looking for another resource, it only make sense for me to hire a qualified C++ programmer rather than a Delphi programmer if I can. Technical writing tools are no different. Become fluent in many tools, and your skills are more marketable. The one point of advice I disagree with is the one I've included above. From my perspective, such a comment would be untrue and would more than likely get you caught out by any interviewer who actually knows the tool. Failing to state the truth during an interview or in your portfolio is not going to win you any points with the hiring parties. 2 cents, Dana W. *** Dana Worley Software Product Manager/Manager, Software Support Group Campbell Scientific, Inc. Microsoft MVP, Windows Help www.jestersbaubles.etsy.com __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] Technical writing and tools
Is there ANY industry that has settled on one tool? Too many employers emphasize tool skills and don't place enough emphasis on critical thinking. Instead, they should be looking at real qualities like: the ability to think, writing skills, and organizational skills. If technical writers cannot learn how to use different tools, how can they ever hope to learn about new technology well enough to write about it? Tom Johnson 231-944-7454 tajohn...@microlinetc.com -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of raj nair Sent: Tuesday, April 27, 2010 3:04 AM To: tcp@techcommpros.com Subject: [TCP] Technical writing and tools Hi All, Does multiple tools restrict the opportunities available for technical communicators? Why is that there is no single standard tool for the technical writing industry? Raj Nair _ Bollywood This Decade http://entertainment.in.msn.com/bollywoodthisdecade/ __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] Writing a user manual
Hello Raj, Maybe you are not asking the correct question. Should your question be, Should I seriously consider feedback from both reviewers? Before you ever start writing the manual you should be asking yourself, Who exactly is my correct audience? You need to define the audience along with your goals (desired outcomes) when you are designing the project. You may need an installation guide as either a separate document or as a section in the user guide. Get someone to review that while they are installing the software from the beginning. Feedback involves many different aspects such as usability, validity, layout, readability, and tone. You don't necessarily have to have access to the application to provide valuable feedback for each aspect. Each of your two reviewers can provide a different, and potentially valuable, perspective on the manual. Certainly, the reviewer that has the software available can provide better validation of manual. That person can make sure you have described the application's features and functions accurately. The user without access to the application cannot be expected to validate anything, but they can provide information on your writing style, correct grammar, and usability to some degree. You just have to be careful how you evaluate the feedback from this group. You really have to consider each case and how the lack of access to the software can influence their comments. The best reviewers are those who fit the description of your target audience. If you can, recruit people who will be beta testing the application. Ideally, those people will be somewhat unfamiliar with the product and generally fall somewhere within the defined target audience. Well, that's kind of the theory of beta testing--a limited group of people who would potentially use the application and have them put it through its paces. If it works in real life, who knows? Regardless, that group can catch a majority of the bugs in your documentation prior to the official product release. Tom Johnson 231-944-7454 tajohn...@microlinetc.com -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of raj nair Sent: Monday, April 05, 2010 10:06 AM To: tcp@techcommpros.com Subject: [TCP] Writing a user manual Imagine that I give a user manual to a potential user to read it without installing or using the application. Simultaneously, I give the same document to another person, who has installed the application and can verify the information in the user manual. In an ideal situation, who exactly is my correct audience? Is it the guy with the installed application and user manual, or the other one? Also, whose feedback should I take seriously? I just want to know how you will deal with such a situation. __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com
[TCP] Clarity in writing (was RE: Comma before clauses beginning with 'if)
Chuck, Thanks for the grammar mini refresher. I'm sure many of us can stand to brush up on our punctuation. I agree with those who say to put the conditional statement first. I've been trying to do that throughout my career. Chuck brings up grammar nuances that many readers may never know or understand. Simple passages add clarity to our writing. If you're having trouble punctuating a sentence, someone is going to have trouble reading it. If that is the case, revise your work. It is that simple. I've been studying a book on Microsoft Access and have stumbled several times on some contractions used in the book. I suspect the author, or maybe the editor, chose to use an informal writing style to make the book seem more friendly. That's okay with some words, but the problem's where nouns are contracted with 'is' to make words that are not part of our normal vocabulary. It was my intention to illustrate the problem in the previous sentence. Personally, I don't stumble over that's, but using the word problem's is a different story. I like a familiar style, but it only took me about 20 seconds to randomly select a page where this problem reared its ugly head. Just for kicks, I'll give you five examples that I found on a randomly selected page. Example 1: In this example, the copyright symbol's being copied with the help of Character Map. Example 2: You can dash off a quick printout by choosing File Print from the menu while your datasheet's visible. Example 3: The key problem's that Access isn't bothered about tables that are too wide to fit on a printed page. Example 4: If you have a large table and you print it out using the standard Access Settings, you could easily end up with a printout that's four pages wide and three pages long. Example 5. To get a better printout, it's absolutely crucial that you preview your table before you print it, as described in the next section. Is it me, or would the first three examples be improved by using the word is instead of a contraction? I found myself stumbling over and over as I'm trying to learn some new techniques in Access. Learning Access is hard enough that I don't want to work so hard trying to decipher an overly-familiar style of writing. Tom Johnson 231-944-7454 tajohn...@microlinetc.com -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of Chuck Beck Sent: Monday, March 29, 2010 10:06 PM To: 'raj nair'; tcp@techcommpros.com Subject: Re: [TCP] Comma before clauses beginning with 'if Hi all, Have been fairly inactive for awhile, but now getting back in the swing of things. So I decided to take a shot at this one, before I read anyone else's responses... To me, your example looks awkward, even incorrect. And, according to that old stand-by, the Chicago Manual of Style, if the dependent clause (in this case, beginning with the word if) is restrictive-that is, it cannot be deleted without altering the meaning of the sentence-then a comma is not required. If the dependent clause is nonrestrictive, meaning it *can* be deleted without significantly altering the meaning of the statement, then it is required. In this case, that would mean that the comma is not required or expected. In any case, I would counsel against constructing a statement, such as the one you provided as an example, with the dependent clause at the end. I very strongly feel that conditional statements should always, always, ALWAYS place the condition *before* the action. Otherwise, the careless user (and there are a LOT of them out there) will typically perform the action and *then* read the condition and then go Oops! (or worse). So, I would never write a statement for users like the one you provide as an example. FWIW... Now I'll go read what others have opined. Hope this helps, Chuck Beck www.swan-cross.com -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of raj nair Sent: Sunday, March 28, 2010 10:57 To: tcp@techcommpros.com Subject: [TCP] Comma before clauses beginning with 'if It is well-known that a comma is used if an if clause is at the beginning of a sentence. Is there a rule, an exception, where the reverse is true? For example, can this punctuation be right? Select the statement cache size, if you get a warning mesaage. Please share your thoughts. _ The world in moving pictures http://news.in.msn.com/gallery/archive.aspx __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial.
Re: [TCP] TCP Digest, Vol 42, Issue 5
Matt, Place the period at the end of the sentence, outside the parentheses (even if it looks odd). Tom Johnson 231-944-7454 tajohn...@microlinetc.com -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of Matt Sullivan Sent: Tuesday, March 30, 2010 12:19 PM To: tcp@techcommpros.com Subject: Re: [TCP] TCP Digest, Vol 42, Issue 5 I agree with Chuck's suggestion of putting the dependent clause at the beginning. In the interest of humor, though... Wrap the dependent clause in parentheses. (if the clause cannot be put at the beginning of the sentence) To me, though, the period at the end of the sentence looks awkward on either side of the parens! For my own reference, can you all tell me where the period should be placed? -Matt Matt Sullivan GRAFIX Training 714 960-6840 714 585-2335 cell /txt/sms skype: mattrsullivan http://www.grafixtraining.com http://blogs.roundpeg.com http://www.linkedin.com/in/mattrsullivan http://twitter.com/mattrsullivan http://twitter.com/roundpeginc -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of tcp-requ...@techcommpros.com Sent: Tuesday, March 30, 2010 9:00 AM To: tcp@techcommpros.com Subject: TCP Digest, Vol 42, Issue 5 Send TCP mailing list submissions to tcp@techcommpros.com To subscribe or unsubscribe via the World Wide Web, visit http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com or, via email, send a message with subject or body 'help' to tcp-requ...@techcommpros.com You can reach the person managing the list at tcp-ow...@techcommpros.com When replying, please edit your Subject line so it is more specific than Re: Contents of TCP digest... ___ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.com http://www.techcommpros.com/componentone/ INTERACTIVE 3D DOCUMENTATION Parts catalogs, animated instructions, and more. www.i3deverywhere.com Today's Topics: 1. Re: Comma before clauses beginning with 'if (Chuck Beck) 2. Clarity in writing (was RE: Comma before clauses beginning with 'if) (Thomas Johnson) -- Message: 1 Date: Mon, 29 Mar 2010 22:05:48 -0400 From: Chuck Beck cb...@swan-cross.com To: 'raj nair' raj_gree...@hotmail.com, tcp@techcommpros.com Subject: Re: [TCP] Comma before clauses beginning with 'if Message-ID: 6e21338a20ee40759af6a27932a74...@homedesktop Content-Type: text/plain; charset=us-ascii Hi all, Have been fairly inactive for awhile, but now getting back in the swing of things. So I decided to take a shot at this one, before I read anyone else's responses... To me, your example looks awkward, even incorrect. And, according to that old stand-by, the Chicago Manual of Style, if the dependent clause (in this case, beginning with the word if) is restrictive-that is, it cannot be deleted without altering the meaning of the sentence-then a comma is not required. If the dependent clause is nonrestrictive, meaning it *can* be deleted without significantly altering the meaning of the statement, then it is required. In this case, that would mean that the comma is not required or expected. In any case, I would counsel against constructing a statement, such as the one you provided as an example, with the dependent clause at the end. I very strongly feel that conditional statements should always, always, ALWAYS place the condition *before* the action. Otherwise, the careless user (and there are a LOT of them out there) will typically perform the action and *then* read the condition and then go Oops! (or worse). So, I would never write a statement for users like the one you provide as an example. FWIW... Now I'll go read what others have opined. Hope this helps, Chuck Beck www.swan-cross.com -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of raj nair Sent: Sunday, March 28, 2010 10:57 To: tcp@techcommpros.com Subject: [TCP] Comma before clauses beginning with 'if It is well-known that a comma is used if an if clause is at the beginning of a sentence. Is there a rule, an exception, where the reverse is true? For example, can this punctuation be right? Select the statement cache size, if you get a warning mesaage. Please share your thoughts. _ The world in moving pictures http://news.in.msn.com/gallery/archive.aspx __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author
[TCP] PowerPoint: Ideal time per page
Greetings, A co-worker asked me if there is some established target for how much time to spend on each slide in a PowerPoint presentation. We're working on a training presentation for clients to introduce a new technology/product line. I'd be interested in what the group has to say about the number of slides per hour and the ideal number of slides per session (assuming training is going to run for most of a day). If you have any suggestions for pacing, suggested length of each session, or any other helpful guidelines, I'd value your input. Thank you in advance! Tom Johnson Technical Writer 231-944-7454 tajohn...@microlinetc.com __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] Find and Replace
Hello Raj, I'm working with Frame 7.2 (not 8.0), but I would suspect the things I've noticed will have carried over into version 8. When using Find, pay attention to the options in the Find dialog box. If you have text selected, I believe the default is to only search the selected text. Consider Case, Whole Word, and Find Backward can also play little tricks on how the search function works. If you're searching for things other than Text:, you must be even more careful. There are nearly two-dozen types of searches including: formats, markers, cross references and a bunch of others. Each of those requires careful attention to entering the right search parameters, but they can be powerful tools, enabling you to search and replace very efficiently. If you're still stuck, I'd be willing to take a look at a specific file and see if I can replicate your problem here with version 7.2. Warmest regards, Tom Johnson -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of raj nair Sent: Monday, January 11, 2010 5:32 AM To: tcp@techcommpros.com Subject: [TCP] Find and Replace When I use Ctrl+F to find topics or body text in FrameMaker 8.0, at times, it fails to find what I am looking at. Any idea why this bug occurs? Is there a workaround for this? Raj _ Windows 7: Simplify what you do everyday. Find the right PC for you. http://windows.microsoft.com/shop __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] FrameMaker Placeholders
I don't have Frame 8, but in Frame 7.2, the term placeholders is used in a number of contexts. A placeholder is something that is used to represent content that is not yet put into position. One instance might be variables where you can insert a variable, such as a product name, and change the definition (the actual text that appears in place of the variable) at any time. Another instance where Adobe uses placeholder is on the master pages where you set up the TOC or index pages. Placeholders are used on the master pages to represent how the TOC or Index entries will appear in the body pages. It may be that version 8 has some new feature called placeholders, but the concept is probably not very different. Basically, the idea is to put something in place that mimics what it will look like when the document is finished. A nice feature would be a way to flag placeholders so that they are not forgotten. Technical writers have sometimes left placeholders in place. Sometimes it's funny, sometimes disastorous. Tom -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of raj nair Sent: Tuesday, January 05, 2010 10:15 PM To: tcp@techcommpros.com Subject: [TCP] FrameMaker Placeholders What is this big deal about FrameMaker 8 placeholders? Moreover, is it placeholders or place holders? Saw both on the Internet. _ New Windows 7: Find the right PC for you. Learn more. http://windows.microsoft.com/shop __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] desktop publishing and accessibility
Hi Lisa, Can you explain more about what you mean by auto tagging? Tom Johnson -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of Lisa Gielczyk Sent: Wednesday, April 29, 2009 12:33 PM To: email Subject: [TCP] desktop publishing and accessibility Hi everyone. Just checking to see if anyone has a recommendation for the best desktop publishing software to use when you need to produce accessible pdf files (for government requirements). From what I've seen, Quark doesn't automatically tag, though that's just from reading documentation, I haven't used Quark, personally. FrameMaker seems to do a good job. Does InDesign do any auto tagging? Thanks, Lisa __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] Medical Writing training?
Hi Gary, One course that may be helpful would be medical terminology. If I were looking to hire a medical writer, that would be one of my first questions. Granted, if you worked in hospitals during college, you may already have a good handle on the vocabulary. Tom -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of Gary G. Robinson Sent: Friday, January 30, 2009 1:05 PM To: tcp@techcommpros.com Subject: [TCP] Medical Writing training? Hello, To stay viable an increasingly challenging marketplace, and having worked my was through college in hospitals, I have been looking for some online training that would help break into medical writing. After a long search I have failed to find anything valid. I did find one website that offers a course in regulatory writing and offers a certificate, but it doesn't appear to be affiliated with anyone! It's just a website that issues certificates. Does anyone know of a legitimate, meaningful, online course(s) in medical writing? Regards, Gary -- Gary G. Robinson Technical Communications Consultant email: g...@ggrtechnical.com phone: 734-426-5218 mobile: 734-775-9787 www.linkedin.com/in/ggrobinson __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] Graphics quality in PDF from OpenOffice
Hi Donna, I wouldn't say that large size is necessarily a result of OOo. Don't be too quick to dismiss a product because of one person's experience. OOo has a lot going for it and many organizations are using it exclusively and successfully. If my software licenses purchased by my employer didn't allow me to also install the programs on my home computer, I might be doing a lot more at home with Open Office. As it is, my old computer is in the process of being reconfigured to run Linux and associated open source software. Open Office will certainly be on that computer. Tom Johnson -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of Jones, Donna Sent: Monday, January 12, 2009 9:58 AM To: TCP@techcommpros.com Subject: Re: [TCP] Graphics quality in PDF from OpenOffice -Original Message- From: McLauchlan, Kevin Sent: Friday, January 09, 2009 10:17 AM Bingo. It wasn't that I hadn't made the settings, it was that I'd somehow managed to specify the wrong joboptions file. All is well, and my 28-page booklet, formerly 22MB, is now 214MB. But crisp and clean, and that's what counts. --- 214 MB for a 28-page booklet??? Yikes! That wouldn't be acceptable for us because we post our PDFs on our web site. Even 22 MB would be too large. I'm glad that I know this. It will make me avoid OOo if I can (as will not knowing what that small letter O stands for! [shudder]). Donna - CONFIDENTIAL- This email and any files transmitted with it are confidential, and may also be legally privileged. If you are not the intended recipient, you may not review, use, copy, or distribute this message. If you receive this email in error, please notify the sender immediately by reply email and then delete this email. __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] Graphics quality in PDF from OpenOffice
Hi Kevin, Here's the process I use when I run into graphics issues. Off the bat, it sounds like a compression issue in Distiller. If checking Distiller doesn't reveal anything obvious, the next thing I try is making a very simple graphic (a circle and a square, for instance) and place it in a new document at its native size. You might want to see how well graphics created in OOo perform as well. That way you can see if you can get the process to work under the best of circumstances. Try placing the test graphic in varying formats to see if there's a vector format that plays nicely with OOo. Here's a tip. Make it easy to identify, from the PDF, which format you used in each instance. You could do that all on one page and see if there's any difference between the formats. Run that through Distiller to see what happens. Then, start working downstream to check settings. OOo settings and distiller settings are both distinct possibilities. If you can't get your test graphics to work, you might as well start looking for another tool. Now you have me curious, and I wish I had time to experiment myself. Tom Johnson -Original Message- From: tcp-boun...@techcommpros.com [mailto:tcp-boun...@techcommpros.com] On Behalf Of McLauchlan, Kevin Sent: Thursday, January 08, 2009 4:51 PM To: TCP@techcommpros.com Subject: [TCP] Graphics quality in PDF from OpenOffice For years, I had done a graphic-heavy QuickStart Guide in FrameMaker (7.1), then published to PDF (Acrobat 7). This time, I revised and reworked in a new format (booklet), using OpenOffice 3 Writer, and publishing through Acrobat 9. In fact, I just created a book in OOo, then used Acrobat 9's Booklet printing feature. I normally print to a file and invoke Distiller. Most of the graphic elements are the one's I'd been using, but now they all appear coarsely pixellated in PDF and printout. An off-white background, for example will consist of several large-ish stepped areas of pale grey. Lines in drawings are surrounded by fuzz. Graphics are about evenly divided between PNG and JPG. Should I be looking first for something in my print settings from OOo, or something in Distiller, or ? I did have to resize most images to fit the new format, but that was true in the FM days, too. The difference is that when importing graphics into FM, I mostly kept re-importing at different sizes until I hit a number that I didn't need to further resize in-situ (by dragging). In OOo, they come in at whatever their large size, and I drag handles to shrink them to fit. The appearance is not acceptable for publication. Where to start looking? Thanks, - Kevin The information contained in this electronic mail transmission may be privileged and confidential, and therefore, protected from disclosure. If you have received this communication in error, please notify us immediately by replying to this message and deleting it from your computer without copying or disclosing it. __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com __ ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or HTML and publish to the Web, Help systems or printed manuals. Download Free Trial. www.doctohelp.comhttp://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email t...@techcommpros.com. Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to tcp-subscr...@techcommpros.com Unsubscribe (email): send a blank message to tcp-unsubscr...@techcommpros.com Need help? Contact listad...@techcommpros.com Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] Adobe InDe$ign
No. There are other resellers out there. I bought the entire suite Creative Design Suite Premium from ZTech Software for about the same price as Adobe was charging for just InDesign. However, when I did that, I was feeling a little vulnerable. I checked reviews of the company and I gained enough confidence to offset my fears that the company I ordered it from was not legitimate. The software arrived reasonably quickly and I was thankful I didn't have to get my credit card company to twist the vendor's arm or anything like that. Tom -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Dan Gallagher Sent: Friday, October 17, 2008 11:43 AM Cc: TCP List Subject: [TCP] Adobe InDe$ign Is Adobe.com the only place to buy this? The boss asked me to get a price. Thanks. __ ComponentOne#174; Doc-To-Help#174; 2008 delivers streamlined authoring features, including new end-user features, all within the brand new Microsoft Office 2007 style interface. Download your FREE trial! http://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com __ ComponentOne#174; Doc-To-Help#174; 2008 delivers streamlined authoring features, including new end-user features, all within the brand new Microsoft Office 2007 style interface. Download your FREE trial! http://www.techcommpros.com/componentone/ Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] first time for everything
Hi Lisa, With 20 weeks of pay, you've got an excellent chance to get a business going. That's far better than having to rely on unenjoyment benefits from the get-go. Use the time wisely and be frugal with the lump sum payment. Resist the urge to go out and buy something special. People have a tendency to squander sudden wealth. You'll probably find yourself struggling financially for a while--at least until you're able to build your reputation as a contractor. I've heard it said that start-ups should have enough cash to operate for a year to be successful and that two years' worth of operating expenses is a better starting point. You'll have about 5 months to get things rolling. So, stretch that money as far as you can make it go. If you do it right, the disciplined approach will pay off big time in a year or two. If I were to recommend one purchase, it would be to buy a decent computer if you don't already own one. It doesn't have to be top-of-the-line, but I'd go for the most bang-for-the-buck. If what you have will work for you, then hold off until your income is more reliable. Don't forget to make your services known to your former employer. More often than not, from people I've talked to, former employers are eager to bring laid-off employees in as contractors. They can't just let the work go undone. When I was laid off, a local quasi-governmental/business organization offered classes for starting a business. They offered lower tuition (25% of full price) for people who were eligible for unemployment benefits. Make sure you check with your local unemployment office. Look for groups in your community that promote small business training like the Chamber of Commerce, S.C.O.R.E. (Service Corps of Retired Executives--I think), or similar agencies. On top of that, you've got some experience running lists like this. That should provide some good background training for soliciting business. You can do it and I suspect many of us might look at you in a couple of years with a bit of envy in our eyes. We'll likely forget the struggles you're likely to have faced along the way. Best of success and keep us posted. Tom Johnson -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Lisa M. (Bronson) Gielczyk (TCP) Sent: Tuesday, May 01, 2007 12:00 PM To: TCP List Subject: [TCP] first time for everything In my ten-year career as a technical writer, I've always been able to say I was never laid off--that is, until last Friday. The company I have been working at for nearly nine years eliminated all three of the technical writers' positions, due to a company-wide reduction following a change in ownership. I've been wanting to start my own business doing interactive 3D documentation (software reseller, training, tech support, and consulting), so it's really quite perfect. Beginning next year, I will be moving frequently as my husband finishes his bachelor's degree, pursues an M.Divdegree, does an internship, works for a few years, and then goes back for his doctorate, so having my own home-based business will be better than getting a new job every 1-3 years. With the elimination of my job, I will be paid through May 15th, and then will receive a lump sum payment for 18 weeks of severence pay. They will continue my health insurance coverage for six months at no cost. Not a bad situation, all things considered. I realize I will have to talk to officials and professionals in some areas, but there are still things I'd like to hear about from people who've been there (and of course, sympathy and encouragement are always welcome, too... even though this is a great opportunity, it's still an emotional experience): * I received severance; can I also get unemployment? Now, or after the18 weeks? * What resources do you know of for starting a business, particularly a woman-owned business? * Have you ever done a press release to announce a new business or make some other announcement? * Corporation, LLC, or other business setup? * Other things I haven't even thought of, yet? Thanks everyone! Lisa G. __ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. DOCUMENTATION TRAINING WEST 07: THE USER EXPERIENCE April 18-21, 2007 ~ Vancouver BC ~ Marriott Pinnacle ~ free city tour 40+ sessions * free workshops * free iPod offer * www.doctrain.com ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole
Re: [TCP] ADMIN Announcement
What in the world is gutersmelt--a beer? I think it would bring up more questions than it answers. Oh well. I'll offer 'geek' as a solution. Tom -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Al Geist Sent: Monday, March 05, 2007 2:49 PM To: 'Guy K. Haas'; 'Lisa M. (Bronson) Gielczyk (TCP)' Cc: 'TCP List' Subject: Re: [TCP] ADMIN Announcement Again...best wishes to you and may you have a long and happy life together; however, I agree with Guy. Maybe you could use a different example than gelding. Something like gutersmelt. Al Guy K. Haas Wrote: Very Best Wishes! And, add me to the list urging gecko or get hitched or gesundheit (or [oy] gevalt?) -- but not gelding. --Guy K. Haas Software Exegete (that one's a soft g) in Silicon Valley Lisa M. (Bronson) Gielczyk (TCP) wrote: Good morning everyone! I apologize for being less than normally attentive last week during the STC and certification threads, but I had a good reason: I was on my honeymoon. :) My new last name is pronounced gel-check, with a hard g sound, like in gelding. __ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. DOCUMENTATION TRAINING WEST 07: THE USER EXPERIENCE April 18-21, 2007 ~ Vancouver BC ~ Marriott Pinnacle ~ free city tour 40+ sessions * free workshops * free iPod offer * www.doctrain.com ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
[TCP] pseudoADMIN STC and Certification
Folks, The reason Lisa asked us to stop the STC rant thread was because several people have unsubscribed in the past couple of days. That should tell us something. The more emotional the topic, the greater the risk of turning people off. The longer a thread runs, the greater the risk of turning people off. Bill Swallow has offered an offline forum to discuss the topic. Perhaps someone would step up and do the same for the certification thread. I think anytime a thread turns into an extended dialog between just a few people, we should consider directing it offline. Any suggestions? For anyone else who may be thinking of unsubscribing, I've considered it too. Lisa is temporarily away on personal business for a few days and will be back soon, otherwise she would've responded to the STC rant sooner. In the meantime, let's all exercise our right to use the delete key. Tom Johnson __ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. DOCUMENTATION TRAINING WEST 07: THE USER EXPERIENCE April 18-21, 2007 ~ Vancouver BC ~ Marriott Pinnacle ~ free city tour 40+ sessions * free workshops * free iPod offer * www.doctrain.com ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] pseudoADMIN STC and Certification
How about a TCP-Offline blog? Does that make any sense? I think it would be great if we had a virtual coatroom to step into when conversations move into the heated or extended category. If we, as professionals recognize when our conversations are bothering others in a real world, couldn't we do the same in a virtual world? To me, it just seems like the polite thing to do. For the record, I think the certification thread has the potential to be beneficial, but I think it would be best handled offline. Lastly, I'm not in charge, but Lisa contacted me yesterday and asked what was going on with the STC rant. I suspect the 'unsubs' triggered a notice for her. I'm just trying to minimize the risk of others unsubscribing until Lisa gets back at the reins. If I'm overstepping my bounds, someone tell me to shut up. Thanks for listening. Tom -Original Message- From: Gordon McLean [mailto:[EMAIL PROTECTED] Sent: Wednesday, February 28, 2007 10:21 AM To: 'Thomas Johnson'; 'TCP List' Subject: RE: [TCP] pseudoADMIN STC and Certification Amen to the last sentence. I realise if people are unsubscribing then it's a bad thing, but as long as the Subject line is maintained then I can quite happily bash the delete key on this entire thread. (I'm not, I'm skim reading it instead). In a side suggestion, I'll happily set up a dedicated blog for such move it offlist discussions. If required, or shall we just continue to camp over at http://techcommdood.blogspot.com/? Gordon -Original Message- The reason Lisa asked us to stop the STC rant thread was because several people have unsubscribed in the past couple of days. That should tell us something. The more emotional the topic, the greater the risk of turning people off. The longer a thread runs, the greater the risk of turning people off. Bill Swallow has offered an offline forum to discuss the topic. Perhaps someone would step up and do the same for the certification thread. I think anytime a thread turns into an extended dialog between just a few people, we should consider directing it offline. Any suggestions? For anyone else who may be thinking of unsubscribing, I've considered it too. Lisa is temporarily away on personal business for a few days and will be back soon, otherwise she would've responded to the STC rant sooner. In the meantime, let's all exercise our right to use the delete key. Tom Johnson __ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. DOCUMENTATION TRAINING WEST 07: THE USER EXPERIENCE April 18-21, 2007 ~ Vancouver BC ~ Marriott Pinnacle ~ free city tour 40+ sessions * free workshops * free iPod offer * www.doctrain.com ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
[TCP] Writing for Standards--Policies and Procedures
Good morning, Has anyone here worked on a project to implement an industry standard? Our company needs to comply to an emerging industry standard (API-1163) and I get to write all the policies and procedures. First of all, it's a very different type of writing. Second, it actually involves adopting three related standards that overlap each other. I'm trying to figure out how to streamline our procedures so that a person doing a certain job doesn't have to read three slightly different procedures all telling him or her to do nearly the same thing. Here are my questions. The three standards have a number overlapping requirements. Has anyone written procedures that reference two or more requirements from different standards? If standard A says you must list the ingredients in an apple pie and standard B says you must identify any pie that contains apples, can you write a procedure that covers both requirements? Maybe that's not the best example, but I think it gets the idea across. Does anyone have any other tips on writing policies and procedures for industry standards? Thanks, Tom Johnson __ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. DITA West 2007--Use a discount code of TECHCOMMPROS to get a discount rate of $200 off the $900 registration price. http://www.travelthepath.com/conf/dita2007.shtml ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] Hello
Oh, you haven't missed much. It seems that questions about blog problems don't rate the same as chopped liver, passive voice, diectic pronouns, or numbered lists in FrameMaker. A few of the rest of us hang out there to invite other quality contributers here. Tom -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Bill Swallow Sent: Monday, February 05, 2007 3:23 PM To: Dick Margulis Cc: tcp@techcommpros.com Subject: Re: [TCP] Hello Ironically, yes, even though that's what led to the dust-up. Dust-up? I guess I missed something. Being blissfully ignorant of that other list has its drawbacks, I guess. ;-) -- Bill Swallow HATT List Owner WWP-Users List Owner Senior Member STC, TechValley Chapter STC Single-Sourcing SIG Manager http://techcommdood.blogspot.com avid homebrewer and proud beer snob I see your OOO message and raise you a clue. __ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. DITA West 2007--Use a discount code of TECHCOMMPROS to get a discount rate of $200 off the $900 registration price. http://www.travelthepath.com/conf/dita2007.shtml ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com __ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. DITA West 2007--Use a discount code of TECHCOMMPROS to get a discount rate of $200 off the $900 registration price. http://www.travelthepath.com/conf/dita2007.shtml ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] equipment for the job (Was: mouse recommendations)
I can't complain about my tower. I have the best one in the building. That's just because I started at the right time when the boss decided to make dual core processors the standard. What a blessing! Last week I splurged a bit and bought myself a Logitech MX Revolution mouse. http://www.logitech.com/index.cfm/products/details/US/EN,CRID=2135,CONTENTID =12134 http://www.logitech.com/index.cfm/products/details/US/EN,CRID=2135,CONTENTI D=12134ad=lgp_MXRev ad=lgp_MXRev Staples had them on sale and I'm so glad I bought it. With a single spin of the scrolling wheel, I can speed through more than a dozen pages of a document. When I see the section I'm looking for, I just touch the wheel and it stops scrolling. Another cool feature is the Document Flip. Forget everything you know about alt-tabbing. A little nudge with my thumb brings up a list of all open windows--at the cursor. It only takes a slight movement to select the window I want. So, if my hand is already on the mouse, about as fast as you can hit the first alt-tab, I can be to the exact window I want. Those are just two of my favorite features and no, I don't work for Logitech. I just really like my new mouse. Tom Johnson [EMAIL PROTECTED] __ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. DITA West 2007--Use a discount code of TECHCOMMPROS to get a discount rate of $200 off the $900 registration price. http://www.travelthepath.com/conf/dita2007.shtml ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] What are YOUR favorite productivity tools?
In addition to the MX Revolution mouse I just mentioned: Total Commander - replacement for Windows Explorer, FTP client, among other things. It took me a while to warm up to it, but now I won't work without it. NoteTab - My favorite text editor because I can automate a bunch of text editing and creation tasks by using macros and other little utilities. Dual monitors - absolutely wouldn't want to be without. I'm trying to figure out how to justify this at home, but I spend so little time on the home computer. Tom Johnson -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Martinek, Carla Sent: Wednesday, January 31, 2007 11:20 AM To: TCP List Subject: [TCP] What are YOUR favorite productivity tools? What equipment do you find essential to completing your job? What are your favorite applications that help you get the job done? Software/Utilities: --iTunes (gotta have that music while working!) --FileBox eXtender (www.hyperionics.com) --FrameMaker Tools: -AutoText (www.siliconprairie.com) -Set Runaround to None plugin (http://www.frameexpert.com/plugins/) -TimeSavers from Shlomo Perets (www.microtype.com) -Archive Utility (http://home.comcast.net/~bruce.foster/Archive.htm) -Shrinkwrap utility (http://www.martinek.us/shrinkwrap.html) Wishlist - other ones I really like, but don't currently have: --QuicKeys --SuitCase (managing fonts) --Dual monitors And probably a few more that I didn't think of yet. Carla cmartinek|zebra|com __ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. DITA West 2007--Use a discount code of TECHCOMMPROS to get a discount rate of $200 off the $900 registration price. http://www.travelthepath.com/conf/dita2007.shtml ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] the traveling technical writer
Previous jobs have provided a few opportunities for travel--mostly conferences. I started a new job this fall and travel is likely. I may even get to go to a desert racing event, which would be WAY cool, as part of my job. Other trips might be to oil rigs or pipeline inspection sites. Those will be interesting, but not as much fun. Tom Johnson -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Lisa M. Bronson (TCP) Sent: Thursday, January 25, 2007 10:54 AM To: TCP List Subject: [TCP] the traveling technical writer Hello everyone, Tomorrow, I send my manager on his way with an updated copy of the I3D presentation I made for the sales manager a couple of weeks ago, which he will show at our company's service conference in Georgia next week. I would have liked to make the presentation myself, but the budget didn't allow it. In the 8 years I've worked here, I have had the opportunity to travel quite a few times, though. Most of it has been for training, but once I got to travel to Nashville to document an add-on machine we purchase from an outside vendor. That was one of my all-time favorite projects! Do you get to travel as a technical writer? For what purposes do you travel? Do you wish you could travel more? Or less? Hope your week's going well! Lisa B. __ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. DITA West 2007--Use a discount code of TECHCOMMPROS to get a discount rate of $200 off the $900 registration price. http://www.travelthepath.com/conf/dita2007.shtml ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] Creeping Deadlines
The problem is the manager solved someone else's problem and not yours. Now you've shown you can pull the rabbit out of the hat and he or she is going to expect you to do that on a regular basis. If the manager is a good one, you'll be compensated accordingly. Tom Johnson Technical Writer Microline Technology Corp. [EMAIL PROTECTED] +1 231 935 1585 -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Gary Robinson Sent: Wednesday, January 10, 2007 11:36 AM To: Lisa M. Bronson (TCP); tcp@techcommpros.com Subject: Re: [TCP] Creeping Deadlines I have a manager on my current project that has twice waltzed in, cut a 5 day deadline to 2 days and doubled the work load to boot. And here I thought managers were supposed to solve problems, not cause them! ;) - Original Message - From: Lisa M. Bronson (TCP) [EMAIL PROTECTED] To: tcp@techcommpros.com Subject: [TCP] Creeping Deadlines Date: Wed, 10 Jan 2007 11:29:24 -0500 Hello, and a belated Happy New Year to you all! :) I returned to work on January 3rd and found out that a 3-week deadline had turned into a 1-week deadline. *gulp* Fortunately, I was able to get it done in time, and amazingly, the project quality didn't suffer. But it could have turned out much differently--we all know the 2-of-3-good-fast-cheap rule! Do you have an interesting story about creeping deadlines? If you do, please share it with the list. I hope your new year is off to a great start! Lisa B. __ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. DITA West 2007--Use a discount code of TECHCOMMPROS to get a discount rate of $200 off the $800 price if you register before close of business January 15, 2007. http://www.travelthepath.com/conf/dita2007.shtml ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] Graphicsless documentation
Those very militant people just don't get it. Not everyone can drive. Does that mean we should stop building roads because not everyone can use them? I'm all for accessibility, but I think we have to be reasonable about what extent we go to make things accessible--sometimes for nothing. Sometimes people take things too far. Oh well. Tom Johnson -Original Message- Dana Worley wrote: On Thursday, December 21, 2006, Brierley, Sean wrote: If accessibility is important, could you not include the graphics (with Alt text) to duplicate and illustrate a point made in the text? Well, of course ;) But many people don't. Thus, I have heard very militant individuals advocate removing all graphics from the documentation to ensure complete accessibility. Dana W. *** Dana Worley Software Product Manager/Manager, Software Support Group Campbell Scientific, Inc. Microsoft MVP, Windows Help __ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. Are you a Help Authoring Trainer or Consultant? Let clients find you at www.HAT.Matrix.com, the searchable HAT database based on Char James-Tanny's HAT Comparison Matrix. Contact [EMAIL PROTECTED] for details. ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] broken cross references
Yes, conditional text could be the problem. It's really hard to tell without digging into the files. Another possibility is if you jammed all the files into a single ZIP file without maintaining the relative paths when you sent them out to the translator. By the way, how many files are there? I just checked out the MIF idea. I was a bit simplistic in my explanation, but it is workable. The biggest hurdle is understanding how MIFs handle the directory structure. I say it's hard because it looks so different. It is logical and once you see the pattern it makes sense, but looks foreign. You almost have to think of it as an HTML format for describing the path to a file. The good news is that it will tell you exactly where Frame expects to find the cross reference and you can find the cross reference target by searching the MIF version. As I expected, you can use Frame's unique ID as the search string. The hard part is deciphering the paths and fixing the problem by either changing the path in the Xref or moving the files to where Frame expects to find them. Tom Johnson Technical Writer Microline Technology Corp. [EMAIL PROTECTED] +1 231 935 1585 -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Brierley, Sean Sent: Wednesday, December 13, 2006 12:38 PM To: tcp@techcommpros.com Subject: Re: [TCP] broken cross references Yuk. 1) You are using relative pathing, correct, where all files live withn the same folder structure and not out on some network drive. 2) How was this translated. Is it possible the translator botched something by translating the MIF files or whatnot? Perhaps the translator deleted cross-reference markers? 3) Could there be issues with conditional text? 4) If the links worked when you sent it out, is the translator responsible for fixing the errors? They might have an easier time with the Japanese. Cheers and g'luck. Sean -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Lisa M. Bronson (TCP) Sent: Wednesday, December 13, 2006 12:11 PM To: tcp@techcommpros.com Subject: [TCP] broken cross references Hi everyone, The longer I use FrameMaker (7.0 p579 on Windows XP), the more I realize I don't know about the program. I sent documents out for translation, and they came back with a number of broken cross references (~50). The only thing I know to do is to look at each corresponding cross reference in the English file, figure out what it's referencing, find the corresponding location in the Japanese, and fix the cross reference to go to that location. Since I don't speak or read Japanese, the thought of doing that 50 times is making me rather cross. :( Does anyone know a better way to fix this? If not, please send chocolate. Lisa B. __ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. Are you a Help Authoring Trainer or Consultant? Let clients find you at www.HAT.Matrix.com, the searchable HAT database based on Char James-Tanny's HAT Comparison Matrix. Contact [EMAIL PROTECTED] for details. ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] graphics - balancing clarity and size
Hi Lisa, You may want to look into a vector-based output rather than a raster image. I'd look at the other export options and perhaps try them all. I'd start with .wmf, .emf, and possibly .svg. I haven't used that last one, but I believe Frame will work with it. I've played around with .png, but not enough to really make any recommendations. So, I should just say, try .wmf, .emf, .svg, .png and any other vector formats you can come up with. Having said that, .png may not be a vector graphic, but it has some advantages--size is one of them. Another thought would be to switch to B/W or grayscale and possibly have I3D show edges. Having edges visible might give you the definition you need. I'd seriously think about using just the edges as long as this can be done as a solid view instead of transparent or wireframe view. Hope at least something here is useful. Cheers, Thomas Johnson [EMAIL PROTECTED] -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Lisa M. Bronson (TCP) Sent: Friday, December 08, 2006 10:42 AM To: tcp@techcommpros.com Subject: [TCP] graphics - balancing clarity and size Hi everyone, I'm on Windows XP using: * IPA 8.1 * FrameMaker 7.0 p579 * PhotoShop 9.0.2 * Corel PhotoPaint 8.369 * Acrobat Distiller 7.0.7 * Acrobat Professional 7.0.8 I have found a new use for IPA, the I3D software I've been using to animate 3D CAD files. I can also save static images and put them into a FrameMaker document, making some of the best looking procedures I've ever produced. The problem I'm having is that the graphics are either very large or they don't retain the clarity I need. I'm trying to find the best balance between the two, particularly in the pdf files, which we may want to email to customers. My experience is more with CAD than tifs, jpgs, and gifs, so I'm looking for ideas, hints, and advice from you. :) In IPA, I'm saving the files as tifs rather than jpgs because I have found tifs give me the crisp, clear lines I need. Saving as gif is not an option in IPA, and when I've tried converting the tifs to gifs in a graphics editing program, importing the resultant file makes FrameMaker crash. The FrameMaker file made with the tifs looks great, and while it's slow and 3.5 MB for a two-page file, I can deal with that for what I'm getting. The file prints slowly, too, but looks awesome. The first time I made a pdf file with the standard job options, the resulting print looked horrible, like I needed a new prescription in my glasses. So, in Acrobat Distiller, I changed the compression option to off. This time, it prints as clearly as the FrameMaker file, but the file is 4.5 MB, which would not be convenient for emailing. Zipping the file works (~350k), I'm just wondering if there is a better way to do what I'm doing. Any thoughts or suggestions for improving this workflow would be greatly appreciated. Happy Friday! Lisa B. __ Are you a Help Authoring Trainer or Consultant? Let clients find you at www.HAT.Matrix.com, the searchable HAT database based on Char James-Tanny's HAT Comparison Matrix. Contact [EMAIL PROTECTED] for details. Interested in Interactive 3D Documentation? Get the scoop at http://www.doc-u-motion.com -- your 3D documentation community. ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
[TCP] Speaking of Graphics
Is anyone using Scribus for DTP? I'm trying to put together a marketing document without buying PageMaker, InDesign, or Quark. MS Punisher, oops I mean Publisher, isn't really up to the task. I'm experimenting with Scribus, but I've run into a huge roadblock. I can't find a way to scale an image to a reasonable size. So far it seems I either have to rely on scripting or resize the image before I import it into Scribus. Is there a way to do this from within Scribus without writing a script? I can't quite imagine trying to tweak several graphics by running a script. Thanks! Thomas Johnson [EMAIL PROTECTED] __ Are you a Help Authoring Trainer or Consultant? Let clients find you at www.HAT.Matrix.com, the searchable HAT database based on Char James-Tanny's HAT Comparison Matrix. Contact [EMAIL PROTECTED] for details. Interested in Interactive 3D Documentation? Get the scoop at http://www.doc-u-motion.com -- your 3D documentation community. ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] Painful
Oh, just correct it with a red pen and put it up. You'll be the only one that knows there's a typo. Me, I'm wondering if we'll get enough snow to get the XC skis out tomorrow. We're getting dumped upon right now. Thomas Johnson [EMAIL PROTECTED] -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Dana Worley Sent: Friday, December 01, 2006 12:38 PM To: tcp@techcommpros.com Subject: [TCP] Painful It's Friday, December 1, and given my tendency towards structure and order, I went to Borders last night to purchase a calendar so I would have January 2007 in front of me (I keep two calendars up -- one with the current month and one for the upcoming month). I bought a standard sized calendar and a couple of calendars for the family members as Christmas presents. Then, there was this beautiful calendar that caught my eye -- a large format (full-page, no folds 18x24), mostly about the scenery with only a small calendar at the top type of thing. It was pricy (for a calendar), but all photos printed on quality paper suitable for framing, yada yada and at the last minute I picked it up. It's perfect for a bare wall in my office. So this morning, as I'm getting ready to walk out the door with my new calendars in hand, I yell, I can't take this calendar to work! It has a typo! Fine Art Calendar 2007 Where the Perfect Light Embraces Nature and All It's Glory It's Glory! It is Glory! My husband responded from upstairs that it must be painful being so anal. :-) Dana __ Are you a Help Authoring Trainer or Consultant? Let clients find you at www.HAT.Matrix.com, the searchable HAT database based on Char James-Tanny's HAT Comparison Matrix. Contact [EMAIL PROTECTED] for details. Interested in Interactive 3D Documentation? Get the scoop at http://www.doc-u-motion.com -- your 3D documentation community. ___ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
Re: [TCP] ADMIN TCP Site - Want a Wiki?
Char, thanks for the great clarifications. I had forgotten about Wikipedia until Robert mentioned it. I've used a couple other sites that function similar to wiki's, but they don't call themselves anything like wiki. I guess the edit button is a clue I've missed, but it makes sense. Thomas Johnson [EMAIL PROTECTED] -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Char James-Tanny Sent: Tuesday, November 28, 2006 9:04 AM To: tcp@techcommpros.com Subject: Re: [TCP] ADMIN TCP Site - Want a Wiki? I really like the idea. I've been toying with the idea of setting one up on my own, although not for TW. This would be an opportunity to get some experience as a reader/contributor to better understand how they work. I've read about them, but I haven't really used one. Maybe I have and just didn't know it. Most of the time (although not always), the domain name includes wiki. For example, see Wikipedia (http://www.wikipedia.org) and the MSHelpWiki (http://www.mshelpwiki.com). Wikis can also be identified by their interface...either buttons or tabs are displayed that include Edit, History, etc. I'd like to see some of our threads migrate to a wiki. It seems like some threads might warrant going deeper into the subject. Would a wiki enhance that? It could. For example, a wiki would allow for more in-depth discussions about different topics. To use it regularly, how would we know about new topics? Sorry, I'm kind of naïve. Would it be something we would have to check on a regular basis to see what's new? Or, could we get a teaser in e-mail form? For instance, a new software product comes out that's intended for the TW community, would we get an e-mail saying, come see the new wiki entry about T-Writersaurus X ? Most wikis include RSS feeds for updated pages. Depending on the wiki, you could even get individual RSS feeds by section (for example, the MSHelpWiki has sections for content, a blog, etc.) Some wikis have what are called watched pages. If there's a page that you want to track the progress of, you click the watch icon, and when the page is changed, the wiki sends you an email. (The MSHelpWiki has this feature, too.) Char James-Tanny ~ JTF Associates, Inc. ~ http://www.helpstuff.com -- ___ Are you a Help Authoring Trainer or Consultant? Let clients find you at www.HAT.Matrix.com, the searchable HAT database based on Char James-Tanny's HAT Comparison Matrix. Contact [EMAIL PROTECTED] for details. Interested in Interactive 3D Documentation? Get the scoop at http://www.doc-u-motion.com -- your 3D documentation community. ___ Technical Communication Professionals To post a message to the list, send an email to TCP@techcommpros.com To subscribe or unsubscribe via the World Wide Web, visit http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com or, via email, send a blank message [EMAIL PROTECTED] Visit the TCP site at http://www.techcommpros.com To find out more about the list, including archives and your account options, visit http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com If you need assistance with the list, write to [EMAIL PROTECTED]
Re: [TCP] How would you express uncertainty in documentation?
I think I would just take the reference out altogether. If you don't know, why confuse the buyer? Just let them assume there's no cable. Worse things could happen than buying a cable you don't need. Thomas Johnson Microline Technology Corp. Traverse City, MI [EMAIL PROTECTED] -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Beth Agnew Sent: Tuesday, November 28, 2006 4:01 PM To: tcp@techcommpros.com Subject: Re: [TCP] How would you express uncertainty in documentation? snip I liked Jeff Hanvey's solution -- a checkbox on a parts list that shows whether the USB cable is supposed to be included or not. Otherwise, you have to build in the idea of uncertainty from the beginning -- Not all models include all peripheral cables. You may need to purchase a USB cable. --Beth Milan Davidovic wrote: Have a look at this: http://weeklyscheiss.blogspot.com/2006/11/oh-good-grief.html And suggest how the TWer in question should have handled the business about the cable. ___ Are you a Help Authoring Trainer or Consultant? Let clients find you at www.HAT.Matrix.com, the searchable HAT database based on Char James-Tanny's HAT Comparison Matrix. Contact [EMAIL PROTECTED] for details. Interested in Interactive 3D Documentation? Get the scoop at http://www.doc-u-motion.com -- your 3D documentation community. ___ Technical Communication Professionals To post a message to the list, send an email to TCP@techcommpros.com To subscribe or unsubscribe via the World Wide Web, visit http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com or, via email, send a blank message [EMAIL PROTECTED] Visit the TCP site at http://www.techcommpros.com To find out more about the list, including archives and your account options, visit http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com If you need assistance with the list, write to [EMAIL PROTECTED]
Re: [TCP] Ending use of end-user
Actually, I was the one who suggested something like, person doing the scanning which is what I thought the original poster was trying to say. Scanner settings seems like it refers to hardware. In Sean's use of names, wouldn't that get confusing in the case of multiple people with different roles? Uma (the network admin) and John (the user) could be ambiguous without their titles. I can see where actors could help solidify some concepts, but I don't think they would be the best in all situations. Thomas Johnson Microline Technology Corp. Traverse City, MI [EMAIL PROTECTED] -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Sean Hower Sent: Thursday, November 23, 2006 12:31 PM To: tcp@techcommpros.com Subject: Re: [TCP] Ending use of end-user Thomas Johnson wrote: The administrator establishes the scanner settings. Top-drawer solution. :-) Which then brings up yet another point, why say user when using such a term can be avoided while not affecting clarity, accuracy, and concision. I've moved into a business analsyt role and one of the things that I've done is create user roles--for the software that I am working with there are about 10 or so different users--and have begun talking in terms of these roles. I am taking this one step further and, in my scenarios I will be using actors (by name) to represent each of these roles. My hope is that eventually our development team will move away from saying user and referring to these user classes by name. So, we can ask ourselves if Uma will need a certain piece of functionality or if John will find a piece of functionality difficult. These are more than user classes but less than personas. Sean Hower - communications specialist http://www.seanhower.com _ Create your own web site for FREE at http://www.freehomepage.com ___ Are you a Help Authoring Trainer or Consultant? Let clients find you at www.HAT.Matrix.com, the searchable HAT database based on Char James-Tanny's HAT Comparison Matrix. Contact [EMAIL PROTECTED] for details. Interested in Interactive 3D Documentation? Get the scoop at http://www.doc-u-motion.com -- your 3D documentation community. ___ Technical Communication Professionals To post a message to the list, send an email to TCP@techcommpros.com To subscribe or unsubscribe via the World Wide Web, visit http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com or, via email, send a blank message [EMAIL PROTECTED] Visit the TCP site at http://www.techcommpros.com To find out more about the list, including archives and your account options, visit http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com If you need assistance with the list, write to [EMAIL PROTECTED] ___ Are you a Help Authoring Trainer or Consultant? Let clients find you at www.HAT.Matrix.com, the searchable HAT database based on Char James-Tanny's HAT Comparison Matrix. Contact [EMAIL PROTECTED] for details. Interested in Interactive 3D Documentation? Get the scoop at http://www.doc-u-motion.com -- your 3D documentation community. ___ Technical Communication Professionals To post a message to the list, send an email to TCP@techcommpros.com To subscribe or unsubscribe via the World Wide Web, visit http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com or, via email, send a blank message [EMAIL PROTECTED] Visit the TCP site at http://www.techcommpros.com To find out more about the list, including archives and your account options, visit http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com If you need assistance with the list, write to [EMAIL PROTECTED]
