[TCP] Task Oriented Writing
Switching from a very prescriptive style to a task oriented style is a mind shift for most writers, and whilst it's one thing to understand the theory of something, making it part of your natural working practise is another. Having read a few articles, and done a little research into what task oriented writing is, I think I understand the basics and have started to apply some of the principles to some of the stuff I'm currently working on. However I do find myself breaking out into the old functionality focussed method and I really need a way, a trick or hack or whatever, to keep myself think task task task. Is it enough to have a list of tasks pinned up somewhere? How do you fit your natural writing process into this method of writing? Typically I tackle concepts first, before worrying about how you do something, is that still valid? Also interested to hear from anyone who has managed a team through such a transition. If you have any suggestions or thoughts, I'd really appreciate them. Yours in curiosity, Gordon 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 __ 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. 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
[TCP] Task Oriented Writing
I haven't managed a team, but at a major computer manufacturing firm, I frequently had to convert functional specs into task-oriented customer documentation. I found that it was helpful to ask a couple of questions: 1. Who would be using this feature or function and why? 2. Why did the developers include the feature or function in the product? What customer need(s) were they meeting? An example from my own learning is the use of layers in graphics editing. The person I was learning from did not know about layers. In a simple-minded way, I'd just make one change after another (to a jpeg) and use Edit-Undo to back out undesirable changes. Every time I saved my work, I made a new file with the change indicated in the new file name. Yes, I understood intellectually why layers would help with creating composites. (Think of the cat in the hat's balancing act.) But I wanted to fix flawed photographs. It wasn't until I figured out how to use adjustment layers to play with color casts and exposure levels 'n' such that I met MY needs. An Aha! moment. So, in conveying the usefulness of a product or feature, I try to imagine a situation in which someone is faced with a problem that the product or feature can help solve. Tell a story about solving that problem. Getting down to a stepwise procedure, with a real-world example (that makes sense in the reader's mind) can help clarify the task. In editing a photograph with a color cast, I could talk about pixels and color space and gamut and histograms, but the task is: (1) find a color photograph whose color doesn't look right; (2) in that photograph, find a spot that should be pure black but is not black; (3) use tools to change the file such that that spot actually was black; (4) assess the effect on the whole photo. Do similar steps for a spot that should be pure white but is not white and (trickier to identify) a spot that should be a neutral, medium gray but is not neutral, medium gray. I think that some people are brilliantly inventive at finding ways to make use of things. Just tell 'em what something is and they'll design, create, produce, without being told how-to. Other people relish being given steps to take (1-2-3's) with realistic examples. Bob Stromberg Greenwich, NY __ 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. 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
[TCP] JOBS: Two full-time permanent positions, remote preferred
*PGP Corporation is currently looking to fill a couple of positions for Senior Technical Writer. One position is with the Server Products group, the other is with the Client Products group. Although PGP Corporation is based in Palo Alto, California, location is flexible.* * * The writer for either group will create and maintain documentation for the PGP product lines. Documentation may take the form of guides, online help, short How do I…? videos created using screen video capture software, or technical notes. As a senior level writer, this person is expert in the technical writing process and many industry-standard technologies and understands industry initiatives such as content management, single sourcing, XML, and so on. The candidate will obtain necessary information from available documents and subject matter experts as well as through direct testing of the software itself, and will develop product expertise over time. The Server Products Senior Writer will report to the Sr. Manager of Technical Education, and must have proven success working independently from a remote or home office.** * * *General requirements are similar for both product groups:* - 5+ years experience as a technical writer developing end user or system administrator documentation for a technical audience - In-depth knowledge of documentation and online help creation - Experience developing and maintaining detailed documentation plans and schedules for assigned projects from work conception through review to delivery - Outstanding writing and editing skills - Visually oriented with the ability to communicate graphically via quick start cards or screen videos as elegantly as with prose - Technically inquisitive nature with a fearless approach to technology - Commitment to maintaining subject matter expertise in functional area - Results-oriented: you get things done, and done well, and are focused on the details - Strong ability to multi-task, prioritize, schedule, and meet deadlines *Other desirable* requirements include:** - Experience with the AuthorIT content management system - Experience with Camtasia or Captivate screen video capture software - Experience with Flash and ActionScript - Experience with the process of localizing documentation - Experience with PGP and other security products - Understanding of networking and network protocols; messaging and mail protocols - B.A./M.A. or Certificate in Technical Writing, Professional Writing, Computer Science, Engineering or equivalent experience *To apply for this position, please send your resume to [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. 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] JOBS: Two full-time permanent positions, remote preferred
Just to clarify something... Yes, I work for PGP. Yes, one of the positions is in my group (I do client product docs). Yes, we have a LOT of work coming up, and a lot of cool things happening (especially on the client side). And yes, we're trying to hire quickly!!! grin ...sue __ 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. 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
