<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>PoeWar &#187; Technical Writing</title>
	<atom:link href="http://www.poewar.com/category/technical-writing/feed/" rel="self" type="application/rss+xml" />
	<link>http://www.poewar.com</link>
	<description>Writing Career Center</description>
	<lastBuildDate>Thu, 18 Mar 2010 19:43:22 +0000</lastBuildDate>
	<generator>http://wordpress.org/?v=2.9.2</generator>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
			<item>
		<title>The Technical Writing FAQ</title>
		<link>http://www.poewar.com/the-technical-writing-faq/</link>
		<comments>http://www.poewar.com/the-technical-writing-faq/#comments</comments>
		<pubDate>Sat, 24 Oct 2009 16:58:04 +0000</pubDate>
		<dc:creator>John Hewitt</dc:creator>
				<category><![CDATA[Corporate Life]]></category>
		<category><![CDATA[Education]]></category>
		<category><![CDATA[Technical Writing]]></category>
		<category><![CDATA[Writing]]></category>
		<category><![CDATA[Writing Business]]></category>
		<category><![CDATA[become a technical writer]]></category>
		<category><![CDATA[technical writer cover letter]]></category>
		<category><![CDATA[technical writer skills]]></category>
		<category><![CDATA[technical writing faq]]></category>
		<category><![CDATA[Technical Writing Jobs]]></category>
		<category><![CDATA[technical writing rate]]></category>
		<category><![CDATA[types of technical writing]]></category>
		<category><![CDATA[types technical writing]]></category>

		<guid isPermaLink="false">http://www.poewar.com/archives/2004/10/24/the-technical-writing-faq/</guid>
		<description><![CDATA[Questions include:
What are the primary skills of a technical writer? How do I become a technical writer? What should I take in College? I have no experience, how do I get my first job? Do I need a sample? What is the best way to look for a job? What should my resume look like? What kind of cover letter should I use? What should I ask for in negotiations? What is a good rate? Is it better to take a permanent job or a contract? Why are there more contract/consultant jobs then there are permanent jobs? Why don't more companies value technical writing? What types of documents do technical writers create?]]></description>
			<content:encoded><![CDATA[<h2><strong>What are the primary skills of a technical writer? </strong></h2>
<p>The first skill a technical writer should have, of course, is writing. You should be able to write in a clear, concise manner. Technical writing is not poetry or prose. Depending on where you work, you may or may not be able to add some stylistic flair. Either way, your job is to clearly tell your audience exactly what they need to know, and everything they need to know.</p>
<p>The second skill you should have is knowledge of a technical subject. My emphasis has always been in the field of computers, which is probably the largest segment of the technical writing market. Your knowledge can be in many other areas, however, such as science, medicine, engineering, mechanics, or law.</p>
<p>No matter what your area of knowledge, you will need computer skills, especially desktop publishing skills. At minimum, you should know the Microsoft Office suite of applications, especially Microsoft Word. Beyond Office, there is Adobe FrameMaker, which is used in many technical-writing environments. Other publishing packages such as PageMaker, Quark Express, and Interleaf can also be useful. In addition, online documentation tools such as RoboHelp, Doc-to-Help and Lotus Notes are great applications to have on your resume, as are HTML and other Internet skills.</p>
<p>In addition, you should try to develop interviewing skills, because you will probably find yourself interviewing technical people to get the information you need for your documents. Often, they will have no idea how to tell you what you need to know, so it is up to you to figure out how to draw the information out of them.</p>
<h2><strong>How do I become a technical writer? </strong></h2>
<p>This is my most frequently asked question, and a difficult one to answer. I can only tell you how I got into it. I have spent my entire adult life (and a good deal of my youth) as a writer of some form or another. When I entered college, I became first a reporter for and eventually the editor of my college newspaper. It was exciting, interesting, and very stressful. When I chose a major in college, I finally settled on creative writing, with a minor in English. I took very few technical courses in college and I have never taken a course in technical writing.</p>
<p>What I did do was work with computers, constantly. I got my first computer when I was 13 years old and I have never been without one since. In high school and at the beginning of college, I took some programming classes, but only about three of them. The rest of my computer skills I acquired either at home or on the job. When I transferred from my community college to the University of Arizona, I got a job in their computer department in the &#8216;Courseware Library for Instructional Computing&#8217;. There, I was exposed to just about every micro platform available at the time (IBM, Apple/Macintosh, Next, Commodore) and hundreds of software programs. I enjoyed it and I eventually began to teach seminars in Macintosh computing to the faculty and staff. While doing so, I wrote some short manuals and performed other various desktop publishing functions. After college, I had a series of jobs, all of them either computer, publishing, or writing related, until I eventually found myself out of work and needing a career path. I had done some technical writing as part of my past jobs, and I decided that I should dedicate my efforts towards building a career there.</p>
<p>Despite being broke, I managed to acquire my own copy of FrameMaker, and train myself on the package, adding that to my skills in PageMaker. I also taught myself HTML programming and learned to read C and other languages that I had not visited in many years. I sent out over 300 resumes and refused to settle for less than what I wanted. I used up all of my unemployment and dug myself deeply into debt.</p>
<p>Then, I received two job offers. The first one was to work as an Internet content developer for my local newspaper. It paid eight dollars an hour for 30 hours a week of work. I was willing to take it, and would have, but right as I was about to I got a call from a contract agency I had sent my resume to. Another local company was looking for a technical writer for a six-month contract. It paid $20.00 an hour, but much of that got sucked up when I opted for salary and benefits such as medical and dental insurance, holidays, sick days and vacation days. In the end, I started at $29,000 a year and after 6 months I renegotiated to $35,000. As my experience has grown, so has my pay.</p>
<h2><strong>What should I take in college?</strong></h2>
<p>As an undergraduate, I focused on creative writing and English. If I had gone to college with the goal of being a technical writer, I would still have majored in English or Creative Writing, but I would have minored in a technical subject such as computers or one of the sciences. For some, engineering may be a better choice than science. Even if you are a college graduate, you should consider supplementing your education. An associates degree in computers or another technical subject will prove you have learned the basics.</p>
<p>For graduate studies, more and more colleges are offering Technical Writing or Professional communications degrees. I recently went back to school to get a degree in professional communications.</p>
<h2><strong>I&#8217;m just out of college, and I want to be a technical writer, but I have no experience, how do I get my first job?</strong></h2>
<p>The first technical writing job is difficult to get, especially if you were a writing major and did not major (or even minor) in a technical subject. The first thing you need to do is prove you can write. This involves creating a sample of your work, which is not easy to do without having a specific project. What many people do is try to find a short, badly written manual (There are thousands) and re-write it. The other approach is to write a manual about something you know. The key is to have proof you can do the work.</p>
<h2><strong>Do I need a sample? </strong></h2>
<p>Yes. Prospective employers often ask for a sample of your technical writing. This can be a problem because these same employers are likely to tell you that what you write for them is confidential. For this reason, I use a &#8216;fictionalized&#8217; sample. It is based on a short manual I wrote for one company, but I have gone out of my way to change any company-specific information. This was not fun, but it was the best compromise I could come up with. My sample is about 15 pages long. I keep it this short because the employers often want to keep it or review it, and they are not that cheap to reproduce, especially because I have my sample vellum bound with a transparent plastic cover. I also include an explanation of what publishing package I used and what the requirements and restrictions of the project were.</p>
<h2><strong>What is the best way to look for a job? </strong></h2>
<p>The Internet is a great way to look for work, and even better if you are willing to move around. I especially recommend <a href="http://indeed.com">indeed.com</a>, which searches severl employment sites at once. I also try to hit all the local technical employment agencies. The easy way to do this is check the Sunday paper of the town you are interested in and look in the computer or technical employment sections. Look for agencies advertising several jobs and get either their fax numbers or e-mail addresses. They do not have to be advertising technical writing jobs. If they place technical jobs, then it is worth the time to get your resume and cover letter to them.</p>
<p>There has also been a growth in resume distribution services. These companies claim to send your resume to thousands of recruiters. I haven&#8217;t tried this approach, but if you are interested try: EmailMyResume.com, ResumeZapper.com, and ResumeXposure.com.</p>
<h2><strong>What should my resume look like?</strong></h2>
<p>Emphasize your technical skills. If you know a software package or computer platform or if you have a scientific background, make sure you supply details. I am a strong believer that good writing skills are far more important than knowledge of a specific subject or program, but the reality out there is that if you know the programs or subjects they&#8217;re looking for, then you have the distinct edge in getting the job. Writing skill is far down the list of what they take into account. I have gotten two jobs without even providing a sample of my writing. If you would like to have a professional work on your resume, try: Employment911.com or A and A Resume.</p>
<h2><strong>What kind of cover letter should I use?</strong></h2>
<p>If you are contacting an agent and not responding to a specific job request, then simply indicate a few basics about yourself. indicate you consider to be your strongest and most relevant skills. Don&#8217;t make it long and don&#8217;t go out of your way to provide details. If they want to know more, they will ask. Keep it short and simple.</p>
<p>On the other hand, if you are responding to a specific job description, especially if you are responding directly to the employer, then a careful cover letter should be written. Analyze the job description, and in your cover letter state specifically how you qualify for as much of that description as possible. Make them believe that you are exactly what they are looking for. Paraphrase their description as much as possible.</p>
<h2><strong>What should I ask for in negotiations? </strong></h2>
<p>Negotiations are a difficult process. Most agencies work on the &#8220;What pay range are you looking for?&#8221; system. This is a tricky system, but one that can be beaten. The key is to ask for more than you expect to get. Do this every time, and by at lease five dollars an hour. I give this advice for an important reason. If you are dealing with an agency and you under-price yourself, you are at their mercy. They will either give you what you ask for, or whatever the minimum in their range is. That is it. End of story.</p>
<p>However, if you ask for more than what their range is, they will then proceed to tell you what the range is. Remember, you aren&#8217;t dealing with the employer, you are dealing with the agent, and they know what the job will be bid at. When they tell you your rate is too high, ask what the range is and tell them that whatever the high number is will be good enough. It is possible to price yourself out of a job, but frankly, I&#8217;m willing to accept that risk. If you aren&#8217;t, then follow your own instincts.</p>
<p>If you are dealing directly with an employer, negotiations are more difficult. The key here is to wait until they are ready to extend an offer. If they ask early on what you want, tell them that you will be happy to listen to whatever their offer is, once they have one to make. If they get adamant about it, then you&#8217;ll have to name your figure and take your chances. Again, I recommend starting on the high side, but it depends on your instincts and whether you are willing to risk not getting the job in order to get what you want. I have been lucky enough to be pursued by more than one company at a time, and I have been willing to play the two off each other in order to get what I wanted. There is also a big advantage to already having a job when you look for your next job. You have the luxury of saying no.</p>
<p>The one most annoying question an employer can ask me is my past salary history. This has happened a few times, and I have refused to tell them on some occasions and I have told them on others. In both situations, I never got the job, so I can&#8217;t say which practice works best. I always take the question as a bad sign, however. Any company interested in this is not likely to treat their employees well, in my opinion.</p>
<h2><strong>What is a good technical writing rate? </strong></h2>
<p>There is, of course, no clear-cut answer to this. Rates vary according to geography, experience, benefits, and the current job market. As I write this, the market has been slow for a three years but is now starting to pick up. There are still more writers than jobs, but the numbers are evening out.</p>
<p>If money is a prime concern, then you need to be in a major market. I am currently working in Phoenix. Phoenix is a good market because there are several major technology firms (Motorola, Intel, AT&amp;T, American Express, etc.) and there are quite a few smaller companies that employ technical writers. California in general and the San Francisco Bay area (also known as Silicon Valley) specifically are the largest markets, though they have also been the hardest hit by the slowdown in the technical industries. Dallas, Denver, New York, Atlanta, North Carolina and Washington State are also good markets. In those places, contract technical writers commonly make from $15-60 an hour. Salaried employment ranges from $30,000-90,000 a year. There have been more jobs in the lower part of this range during the slump, but compensation is also picking up.</p>
<h2><strong>Is it better to take a permanent job or a contract? </strong></h2>
<p>This depends on the job, of course. I originally chose to go the contract route because I knew that with a couple more years of experience under my belt, I would be able to command much more money than I would when I began, far more than I would be able to count on through raises. I also had no family to support, so I had a certain freedom to move around and to take risks. I did take a permanent position once, but permanence in this industry is an illusion. I have continued to take contract work and I prefer it.</p>
<p>If you do contract, you will find that you are generally treated differently from regular employees. This will vary widely from company to company, but you may or may not find yourself with a little less respect and acceptance, especially as a technical writer. You are disposable. Also, you will be expected to do your own training. Rarely will companies finance training for contractors.</p>
<p>On the up side, you generally attend fewer meetings and deal with less company politics. Also, I have always tried to get my training on the job. Moving from company to company has given me the opportunity to learn a variety of applications that I would be ignorant of if I had only been at a single company all this time.</p>
<p>To me the key difference between contracting and regular employment is one of attitude toward the company. When I am contracting I consider the company to be a client. I probably work harder to give them what they want, but I have less personal interest in the outcome. Even if I feel the project is flawed, I do what they ask because they are a client and that is my responsibility to them. As an employee, I get much more caught up in the reasons for projects. I am more likely to object to a course of action I don&#8217;t feel helps me or the company because I feel it is our mutual responsibility to succeed. I am more invested in the outcome and less concerned with pleasing the company. This may be different for other people, but I think it accurately reflects my past attitudes.</p>
<h2><strong>Why are there more contract/consultant jobs then there are permanent jobs? </strong></h2>
<p>The hard fact is that most companies do not value technical writing. They bring in writers to fill a specific need, often because they have been required to provide documentation for a project. Many companies bring writers in at the end of a project to document what has already been created rather than include writers in the full product cycle.</p>
<h2><strong>Why don&#8217;t more companies value technical writing?</strong></h2>
<p>Much more emphasis is put on the programming side of products than on usability and documentation because these are viewed as secondary issues. I strongly feel this has helped lead the technical industry into its current down cycle.</p>
<p>Technical writers are viewed as a luxury. As valuable as I feel my skills are, and can be to a company, the company can still function without me. If the programs or systems are undocumented, or if they are poorly documented by programmers or analysts, it will not damage the company as obviously as if the program fails to get developed. I happen to feel that a company that spends money on good technical writers will get a very high return for its investment, in more satisfied customers, smoother processes and greater institutional memory. I believe that dollar-wise this can make money for the company, but those are categories that are difficult to measure and often hard for management to comprehend.</p>
<p>Also, some companies do not understand what a technical writer does. Some consider writers to be glorified secretaries, and do such things as give them notes to type up or even have them take minutes at meetings. Part of the problem is that secretaries and administrative assistants have also become a thinning breed, and management (not the upper management, who have secretaries, but the lower management and team members) are desperate for anyone who can make a document look good. I once found myself at a company that constantly asked me to attend meetings simply to record the minutes. I comforted myself with the fact that I was paid $36 an hour to do it, but I also started looking for my next job,</p>
<h2><strong>What types of documents do technical writers create?</strong></h2>
<p>The range of writing a technical writer performs varies widely. Much is dependent on the technical specialty of the writer and of the needs of the company. You may find yourself a part of one large project, or overseeing dozens of smaller projects. You might write manuals, articles, proposals, white papers, product descriptions or any of a hundred other types of documents.</p>
<p>My specialty is writing manuals, especially user manuals and programmer manuals for specific software applications. This is the technical writing I enjoy most, because for me it involves solving problems and figuring out puzzles. To write a user manual, I need to think like the people using the program and try to tell them what they need to know, rather than what I would need to know or what the programmer would need to know. For me, this is a lot of fun and very fulfilling.</p>
<p>There are dozens of different types of writing that come under the banner of technical writing, however. Many people document processes. Processes can be just about any system by which something gets done. For example, in order for a company to generate a payroll, certain actions must be taken, such as logging hours and generating checks. All of those steps are part of a process, and intelligent companies document those processes so that, if an employee leaves or a system goes down, they have something to consult in order to get themselves on track. One name for this type of document is SOP (Standard Operating Procedure).</p>
<p>Another type of documentation is SLA (Service Level Agreement). The SLA describes exactly what a provider (company or department) will do for a customer (another company, another department, or an individual). These can be highly technical documents or busywork, depending on the service and the company.</p>
<p>Proposals, often written in response to an RFP (Request For Proposal) document are much like SLAs. They describe what work will be done, but they require more writing finesse because they are also pitching the service. The company is proposing to sell a service. I have written several proposals, and depending on the request and the company, they can be quite interesting or more busywork.</p>
<p>These are just a few examples of the types of work technical writers perform.</p>
<h2>Hire John Hewitt - Writing Content and Web Consulting</h2>  Email: <a href=\"mailto:hewitt@poewar.com?subject=Business Request\">hewitt@poewar.com</a><br /> Phone: (520) 261-6104<br /><a href=\"http://www.linkedin.com/in/poewar\">LinkedIn Resume</a><br /> ]]></content:encoded>
			<wfw:commentRss>http://www.poewar.com/the-technical-writing-faq/feed/</wfw:commentRss>
		<slash:comments>17</slash:comments>
		</item>
		<item>
		<title>What major/degree is required to become a Technical Writer?</title>
		<link>http://www.poewar.com/what-majordegree-is-required-to-become-a-technical-writer/</link>
		<comments>http://www.poewar.com/what-majordegree-is-required-to-become-a-technical-writer/#comments</comments>
		<pubDate>Sat, 10 Oct 2009 14:33:36 +0000</pubDate>
		<dc:creator>John Hewitt</dc:creator>
				<category><![CDATA[Technical Writing]]></category>
		<category><![CDATA[Writing]]></category>

		<guid isPermaLink="false">http://www.poewar.com/?p=5039</guid>
		<description><![CDATA[There are no specific degree requirements for a position in technical writing. Many technical writers have writing-related degrees such as English, creative writing or journalism. Others have degrees in fields that employ technical writers such as engineering, chemistry, computer science, aerospace, or biology. Some technical writers have completely unrelated degrees. These writers get into the [...]]]></description>
			<content:encoded><![CDATA[<p><img class="alignright size-full wp-image-5041" style="margin: 8px;" title="Diploma" src="http://www.poewar.com/wp-content/uploads/2009/03/diploma1.jpg" alt="Technical Writing Degrees" width="283" height="424" />There are no specific degree requirements for a position in technical writing. Many technical writers have writing-related degrees such as English, creative writing or journalism. Others have degrees in fields that employ technical writers such as engineering, chemistry, computer science, aerospace, or biology. Some technical writers have completely unrelated degrees. These writers get into the business either by being promoted within the same company or hired because of industry knowledge gained on another job. Writing skill, industry knowledge and tools knowledge are what counts in a technical writing job search.</p>
<p>There are a growing number of technical writing degree programs. These programs focus on the creation of technical and educational documents as well as technical editing, usability testing and organizational communication. In the United States, there are technical writing or technical communication degree programs at colleges such as the University of Washington, Bowling Green State University, Texas Tech, and Carnegie Melon. Most technical writers have bachelor degrees. A few of us have advanced degrees. Although it is rare, I have met technical writers without college degrees.</p>
<p>My college degrees consist of an Associate&#8217;s Degree in General Studies, A Bachelor’s Degree in Creative Writing and a Master’s Degree in English with a Professional Writing Certification. I began my career in technical writing long before I had the master’s degree. I had worked in my University’s computer department as an undergrad. It gave me the opportunity work with many different computer systems and applications. I also had the opportunity to work as a computer trainer during and after college. That eventually led to a writing and database development position. From there I got into technical writing. Almost all of my employment history for the past fourteen years has consisted of technical writing or information development jobs.</p>
<h2>Hire John Hewitt - Writing Content and Web Consulting</h2>  Email: <a href=\"mailto:hewitt@poewar.com?subject=Business Request\">hewitt@poewar.com</a><br /> Phone: (520) 261-6104<br /><a href=\"http://www.linkedin.com/in/poewar\">LinkedIn Resume</a><br /> ]]></content:encoded>
			<wfw:commentRss>http://www.poewar.com/what-majordegree-is-required-to-become-a-technical-writer/feed/</wfw:commentRss>
		<slash:comments>3</slash:comments>
		</item>
		<item>
		<title>How to tell if your Project Manager is an Insane Moron</title>
		<link>http://www.poewar.com/project-manager-insane-moron/</link>
		<comments>http://www.poewar.com/project-manager-insane-moron/#comments</comments>
		<pubDate>Fri, 09 Oct 2009 21:15:15 +0000</pubDate>
		<dc:creator>John Hewitt</dc:creator>
				<category><![CDATA[Fun]]></category>
		<category><![CDATA[Productivity]]></category>
		<category><![CDATA[Technical Writing]]></category>
		<category><![CDATA[Writing Business]]></category>

		<guid isPermaLink="false">http://www.poewar.com/project-manager-insane-moron/</guid>
		<description><![CDATA[Based on a true story&#8230;
You are working as a technical writer on a project that has gone horribly and quite predictably wrong. The original sizing for the project was for five technical writers. Your project was given three. One of the three was fired and the other one quit. You are now all that’s left [...]]]></description>
			<content:encoded><![CDATA[<p><img src="http://www.poewar.com/images/impm.jpg" title="Insane Moron Project Manager" alt="Insane Moron Project Manager" align="right" height="331" width="363" /><em>Based on a true story&#8230;</em></p>
<p>You are working as a technical writer on a project that has gone horribly and quite predictably wrong. The original sizing for the project was for five technical writers. Your project was given three. One of the three was fired and the other one quit. You are now all that’s left and the project is overdue. Whose fault is this? It’s yours of course! You’re the lead technical writer. You weren’t the lead originally, that was the guy who quit, but you are “in charge” now and that makes everything your fault – right? Well, it is if you’ve got an insane moron for a project manager. Here are a few more signs that you’ve got an insane moron for a project manager.</p>
<ul>
<li>The PM holds a weekly status report meeting, and then emails you the next day to check on your status.</li>
<li>The PM likes to play motivational music at the beginning of the status meeting – either Eye of the Tiger or The Final Countdown, depending on the project status.</li>
<li>The PM asks you to take the meeting minutes because, “You’re the writer.”</li>
<li>The PM constantly repeats the mantra “faster, better, cheaper” but has never heard of the book.</li>
<li>The PM asks, “All you have to do is write stuff down. Why does that take so long?”</li>
<li>When you tell the PM that the project can’t be done with the available resources the PM says, “I need you to be a team player on this.”</li>
<li>When your co-workers quit, the PM assigns their tasks to the next person on the Excel spreadsheet.</li>
<li>When the project that doesn’t have enough resources goes into Red Status, the PM asks, “What can we do to fix this?” When you tell them that you need more resources the PM asks, “Isn’t there something else we can do?”</li>
<li>The PM assigns you two tasks with the same deadline and tells you that Task One is the highest priority – then calls you every day to check on Task Two.</li>
<li>The PM schedules you for three meetings the day before your deadline.</li>
<li>The PM schedules user testing for two weeks after the documentation is due. Doesn’t understand why you would want that sort of thing in advance.</li>
<li>The PM urges you to think outside the box. He then demonstrates by getting into and out of a box.</li>
<li>The PM “stops by” at five minutes to five, “Just to check on how things are going.” He proceeds to stick around for an hour looking for signs that you were actually thinking of going home.</li>
<li>The PM disappears for a week without notice, then comes back feeling “rested” only to disappear again the next day – never to be seen again.</li>
</ul>
<h2>Hire John Hewitt - Writing Content and Web Consulting</h2>  Email: <a href=\"mailto:hewitt@poewar.com?subject=Business Request\">hewitt@poewar.com</a><br /> Phone: (520) 261-6104<br /><a href=\"http://www.linkedin.com/in/poewar\">LinkedIn Resume</a><br /> ]]></content:encoded>
			<wfw:commentRss>http://www.poewar.com/project-manager-insane-moron/feed/</wfw:commentRss>
		<slash:comments>9</slash:comments>
		</item>
		<item>
		<title>Option Paralysis and the Technical Writer</title>
		<link>http://www.poewar.com/option-paralysis/</link>
		<comments>http://www.poewar.com/option-paralysis/#comments</comments>
		<pubDate>Fri, 14 Aug 2009 20:33:59 +0000</pubDate>
		<dc:creator>John Hewitt</dc:creator>
				<category><![CDATA[Blogging]]></category>
		<category><![CDATA[Corporate Life]]></category>
		<category><![CDATA[Technical Writing]]></category>
		<category><![CDATA[Writing]]></category>

		<guid isPermaLink="false">http://www.poewar.com/?p=6703</guid>
		<description><![CDATA[Option Paralysis: The tendency, when given unlimited choices, to make none. – Douglas Coupland
The saying goes, you can’t get what you want if you don’t know what you want. That is a problem that I’ve been struggling with for quite some time. I have spent the past several years settling for what I can stand, [...]]]></description>
			<content:encoded><![CDATA[<p><strong><a href="http://www.poewar.com/wp-content/uploads/2009/08/jctree.jpg"><img class="alignleft size-full wp-image-6704" style="border: 8px solid white; margin-top: 8px; margin-bottom: 8px;" title="jctree" src="http://www.poewar.com/wp-content/uploads/2009/08/jctree.jpg" alt="jctree" width="272" height="362" /></a>Option Paralysis</strong>: The tendency, when given unlimited choices, to make none. – Douglas Coupland</p>
<p>The saying goes, you <em>can’t get what you want if you don’t know what you want</em>. That is a problem that I’ve been struggling with for quite some time. I have spent the past several years settling for what I can stand, rather than what I truly enjoy. In a way, I have been challenging to see just how much I can put up with and still function. I would commute for two hours a day to work for eight hours a day and then come home and write / work on my blog for another three to four hours a day.  Last winter, after two years of keeping up this grueling schedule, I gave up on my blogging. This is unfortunate because writing this blog was by far the most enjoyable of the tasks that were in front of me.</p>
<p>I have been a technical writer for fifteen years. On my best days, I am great at this job. When the challenge is right and my interest is peaked, I can work magic. Unfortunately, the opportunity to work magic comes up only on occasion. Last summer and fall was one of those times. I was working with a talented and energetic partner, and we did some great work. For a period of over three months, I actually looked forward to getting up in the morning and doing what I was good at. Eventually though, the situation changed and I went back to forcing myself to go to work every day. In June though, I got lucky. I lost my job.</p>
<p>I had lost a lucrative job and all of the security that comes with it. The job market was terrible so my prospects seemed weak. I had mortgage payments, car payments, student loan payments, utilities and a grocery bill to worry about. On occasion, I was scared out of my skull. Most of the time, however, I was happy. I had lost a job, but I had gained ten to eleven hours of my day. My stress level dropped. I stopped having to drink Coffee and Monster energy drinks just to get through the day.</p>
<p>I even managed to keep making money. That was the strangest part of all. The Internet took a shine to me. I found that magic money making formula that Tim Ferris and all of those ads on Facebook claim to have. I figured it out myself though, and unlike them I’m not telling anyone what it is. My site has never been about getting rich on the Internet and it never will be. Sorry.</p>
<p>The upshot of all this is that I have freedom for the first time in a long time. I can do what I want to do. I can write what I want to write. I can pick any direction I please. This has brought on a case of option paralysis. Do I return to blogging? Do I look for that “perfect” technical writing job? Do I pick a new career path?</p>
<p>I am free. Now what?</p>
<h2>Hire John Hewitt - Writing Content and Web Consulting</h2>  Email: <a href=\"mailto:hewitt@poewar.com?subject=Business Request\">hewitt@poewar.com</a><br /> Phone: (520) 261-6104<br /><a href=\"http://www.linkedin.com/in/poewar\">LinkedIn Resume</a><br /> ]]></content:encoded>
			<wfw:commentRss>http://www.poewar.com/option-paralysis/feed/</wfw:commentRss>
		<slash:comments>6</slash:comments>
		</item>
		<item>
		<title>Starting a New Technical Writing Project</title>
		<link>http://www.poewar.com/technical-writing-project/</link>
		<comments>http://www.poewar.com/technical-writing-project/#comments</comments>
		<pubDate>Wed, 28 Jan 2009 05:09:16 +0000</pubDate>
		<dc:creator>John Hewitt</dc:creator>
				<category><![CDATA[Productivity]]></category>
		<category><![CDATA[Technical Writing]]></category>
		<category><![CDATA[Writing]]></category>
		<category><![CDATA[project preparation]]></category>

		<guid isPermaLink="false">http://www.poewar.com/?p=5014</guid>
		<description><![CDATA[They picked you. You get to be on the new documentation project. You might even be leading it. This may be a new duty at an existing job or a whole new job. You need to get up and running and prove that they made the right choice when they decided on you. Here are [...]]]></description>
			<content:encoded><![CDATA[<p><img class="alignright size-full wp-image-5015" title="They Picked You!" src="http://www.poewar.com/wp-content/uploads/2009/01/chosen.jpg" alt="They Picked You!" width="287" height="418" />They picked you. You get to be on the new documentation project. You might even be leading it. This may be a new duty at an existing job or a whole new job. You need to get up and running and prove that they made the right choice when they decided on you. Here are a few things that you should do at the beginning to make the rest of the project easier.</p>
<p><strong>Put the past behind you</strong></p>
<p>Projects create things like paper files, computer files, sticky notes, white board entries and the like. When you are starting a new project, you want to put any dead projects behind you. Whether you throw your old files away or just put them aside for safe keeping, now is the time to purge. You&#8217;ll want plenty of space (physical and mental) for the new project to occupy. This is also a good time to remind yourself that any personal conflicts you had in the past with potential teammates and other working relationships need to be put in the past. A fresh project needs a fresh outlook.</p>
<p><strong>Create a project file</strong></p>
<p>A new project requires new files, whether they are on your computer or in your file cabinet. Create a space to store all of the documents that inevitably come in as a project moves forward. This includes previous documentation attempts, specifications and business reviews, emails, notes, project tracking, graphics and anything else that needs to be captured.</p>
<p><strong>Set up a tracking system</strong></p>
<p>There are more ways to track a project than you can count. People use to-do lists, milestones, Gantt charts, daily calendars, workweek calendars, personal organizers, Blackberries, Microsoft Outlook, Lotus Notes, color coding, severity levels, Harvey Balls and a variety of other systems. Use what your company wants or whatever works for you, but take the time to track your progress on the project. Not knowing where you are makes it hard to decide where you are going.</p>
<p><strong>Make a contact list</strong></p>
<p>New projects often come with new people. You need to remember who does what and how to contact people when you need to. Even if you are working with the same group you always work with, it doesn&#8217;t hurt to make sure everyone has the same email addresses, phone numbers and job roles that you think you remember. Additionally, you need to record information about file locations, websites, logins, teleconference phone numbers, meeting room phone numbers and any other key information that you&#8217;ll need at your fingertips. I recommend programming this information into your mobile phone so that it is with you all the time, but make sure you have another version you can access from your computer.</p>
<p><strong>Remind yourself to relax</strong></p>
<p>New projects can be tense, especially at the beginning and near the end. At the beginning people are struggling to find their roles and define their needs. Towards the end people are under the pressure of deadlines, especially if a project has fallen behind. It is easy to get overstressed. When you feel yourself starting to lose perspective and get tense, find a way to relax. Tense people tend to make bad decisions, and then they have to scramble even more to correct them. Find a way to constructively release the pressure. Tools include meditation, stretching, walks or other exercise, and friends. Take the time to deal with your stress and relax. In the long run you will be more effective.</p>
<h2>Hire John Hewitt - Writing Content and Web Consulting</h2>  Email: <a href=\"mailto:hewitt@poewar.com?subject=Business Request\">hewitt@poewar.com</a><br /> Phone: (520) 261-6104<br /><a href=\"http://www.linkedin.com/in/poewar\">LinkedIn Resume</a><br /> ]]></content:encoded>
			<wfw:commentRss>http://www.poewar.com/technical-writing-project/feed/</wfw:commentRss>
		<slash:comments>4</slash:comments>
		</item>
		<item>
		<title>I See Dead Projects</title>
		<link>http://www.poewar.com/i-see-dead-projects/</link>
		<comments>http://www.poewar.com/i-see-dead-projects/#comments</comments>
		<pubDate>Fri, 05 Dec 2008 14:51:26 +0000</pubDate>
		<dc:creator>John Hewitt</dc:creator>
				<category><![CDATA[Blogging]]></category>
		<category><![CDATA[Corporate Life]]></category>
		<category><![CDATA[Technical Writing]]></category>
		<category><![CDATA[Writing]]></category>
		<category><![CDATA[Writing Business]]></category>
		<category><![CDATA[projects]]></category>

		<guid isPermaLink="false">http://www.poewar.com/?p=4959</guid>
		<description><![CDATA[
One of the great things about blogging is that, for the most part, there is little lead time. You write something and then you publish it. If you&#8217;re lucky, you get feedback and if it is particularly good you get repeat visitors. You might write ahead, gathering several days or even weeks worth of posts [...]]]></description>
			<content:encoded><![CDATA[<p><a href="http://www.poewar.com/wp-content/uploads/2008/12/deadprojects.jpg"><img class="size-full wp-image-4961 alignright" style="margin: 8px;" title="I see dead projects" src="http://www.poewar.com/wp-content/uploads/2008/12/deadprojects.jpg" alt="I see dead projects" width="283" height="424" /></a></p>
<p>One of the great things about blogging is that, for the most part, there is little lead time. You write something and then you publish it. If you&#8217;re lucky, you get feedback and if it is particularly good you get repeat visitors. You might write ahead, gathering several days or even weeks worth of posts in advance, but for the most part you are writing as you go.</p>
<p>In the world of technical writing, you are often assigned to projects that last for months or even years, and in many cases the material you write today may not be read for a long time. Occasionally, it won&#8217;t get read at all, at least not by the people you intended it for. This has been a fairly regular occurrence in my career. My first major project lasted a year. At the end of that year, the company was part of a merger and moved to the other company&#8217;s software platform, negating all of my work.</p>
<p>Later on in my career, I documented what was expected to be a major product for a very large hardware/software company.  Because of the lead time for localization, I had to complete the documentation two months before the product was to be released. I had just finished up and sent off my work to the translators when word came down that the project was being scrapped due to a poor business case. Poor business case was code for, &#8220;our competitors decided to include this tool for free in their new operating system&#8221;.</p>
<p>My most recent bout of deadprojectitis hasn&#8217;t been quite as severe. The product I have been working on for the past two years was released and most of my documentation is at least available to customers. Nonetheless, the product is on its way out. It won&#8217;t be gone today or tomorrow, but it is being replaced by something newer and shinier and almost certainly better. The change came suddenly. Just a month ago, it looked like the product would be getting a major overhaul that would have me up to my armpits in documentation for the next six months, but things change.</p>
<p>In all of these cases, far more than my own efforts were negated. There were programmers, engineers, project managers, product managers, business analysts and a host of other people who had their efforts negated. These things happen. Companies change direction, market forces change people&#8217;s needs, competitors beat you. This is the world of business and it is frustrating. In some cases people don&#8217;t just see their hard work pushed aside, they actually lose their jobs. There isn&#8217;t always another project waiting around the corner. These are the realities of the business world. In the current economy, it is something you&#8217;ll see more and more of. Companies will be cutting expenses, and often that comes in the area of new development, or the elimination of existing products.</p>
<p>There is no magic solution to this problem. It helps if you can be assigned to more than one project, so that you aren&#8217;t defined by a single product, but those choices aren&#8217;t always your to make. This is the business world. When things do wrong you pick yourself back up, dust yourself off and get back in the game.</p>
<h2>Hire John Hewitt - Writing Content and Web Consulting</h2>  Email: <a href=\"mailto:hewitt@poewar.com?subject=Business Request\">hewitt@poewar.com</a><br /> Phone: (520) 261-6104<br /><a href=\"http://www.linkedin.com/in/poewar\">LinkedIn Resume</a><br /> ]]></content:encoded>
			<wfw:commentRss>http://www.poewar.com/i-see-dead-projects/feed/</wfw:commentRss>
		<slash:comments>4</slash:comments>
		</item>
		<item>
		<title>Will The Recession Hurt Your Writing Career?</title>
		<link>http://www.poewar.com/will-the-recession-hurt-your-writing-career/</link>
		<comments>http://www.poewar.com/will-the-recession-hurt-your-writing-career/#comments</comments>
		<pubDate>Fri, 03 Oct 2008 14:06:05 +0000</pubDate>
		<dc:creator>John Hewitt</dc:creator>
				<category><![CDATA[Editing]]></category>
		<category><![CDATA[Featured]]></category>
		<category><![CDATA[Freelance]]></category>
		<category><![CDATA[Freelancing]]></category>
		<category><![CDATA[Technical Writing]]></category>
		<category><![CDATA[Writing]]></category>
		<category><![CDATA[Writing Business]]></category>

		<guid isPermaLink="false">http://www.poewar.com/?p=4576</guid>
		<description><![CDATA[
The recession is starting to get painful
I know that there are some people out there who don&#8217;t think that we&#8217;re in a recession. Some of those same people believe that a 700 billion dollar bailout of the financial caretakers who made bad bets with our money is a good idea. What I know is that [...]]]></description>
			<content:encoded><![CDATA[<p><img class="alignright" style="margin: 8px; float: right;" title="Job Market Has Gone to the Dogs" src="http://www.poewar.com/images/outofworkdog.jpg" alt="Job Market Has Gone to the Dogs" width="283" height="424" align="right" /></p>
<h3>The recession is starting to get painful</h3>
<p>I know that there are some people out there who don&#8217;t think that we&#8217;re in a recession. Some of those same people believe that a 700 billion dollar bailout of the financial caretakers who made bad bets with our money is a good idea. What I know is that my 401k is down 18% over the past year and it wasn&#8217;t due to me taking a whole bunch of chances. I chose the most conservative portfolio my company offered. I know that my company&#8217;s stock value, despite the company making its financial projections, is down by half. There haven&#8217;t been any layoffs in the past year, but hiring at the company has become anemic. They aren&#8217;t replacing the people who leave unless the absolutely have to.</p>
<p>As a person who posts job openings across the writing industry on my site, I know that it is getting harder for me to find good jobs to post.  I know that at least one writing career path, newspaper reporting, is experiencing a record number of layoffs. Take all that together and we&#8217;ve got trouble. If you don&#8217;t want to call it a recession, or a &#8220;slowdown&#8221;, feel free to call it &#8220;that lack of jobs thing&#8221; or something else that makes you comfortable.</p>
<p>Whatever the case, it is time to look at where the jobs are and where they aren&#8217;t, at least from what I have observed so far. Let me clarify that I base my opinion on three things: articles I am reading, trends I have observed as someone who posts jobs, and conversations I have had with other writers. This is not a newspaper report, it is my view of the situation. Call me a pundit, if you will.</p>
<h3>Newspapers are doing badly</h3>
<p><a href="http://stlouis.bizjournals.com/stlouis/stories/2008/10/06/story2.html?b=1223265600^1710102">Newspapers</a>, of course, are the hardest hit employers of writers. Their industry-wide payrolls were declining even before the general economy went into the tank. <a href="http://www.oxan.com/worldnextweek/2008-10-02/HardTimes.aspx">Newspaper circulations</a> have been down for years. People don&#8217;t read the newspapers as much as they used to, and when they do, they generally read them online where revenue is tough to come by. Poor circulation reduces both newsstand income and advertising revenue. Now that the economy is bad, advertising income is dropping even more sharply as companies cut their advertising budgets. In the United States, the election season is helping offset some of those losses, but after the first weekend in November, that income will dry up. This is a terrible time to be looking for a newspaper job, there&#8217;s no way around that. Other media outlets such as television and radio stations <a href="http://www.forbes.com/media/2008/10/01/media-magazines-newspapers-biz-media-cx_jb_1001brady.html">are also feeling the pinch</a>, but to a lesser extent. Their markets aren&#8217;t on the ropes the way the newspaper market is, but they are experiencing the same downturn in advertising as the newspaper industry is.</p>
<h3>Copywriting isn&#8217;t too strong either</h3>
<p>The copywriting industry is experiencing the slowdown as well. When companies cut their advertising budgets, it hits the people who create the advertising. There are <a href="http://www.nytimes.com/2008/09/22/business/media/22adcol.html?ref=business">some layoffs and a significant reduction in hiring</a>. I&#8217;ve noticed a definite drop in the number of positions being advertised in this field. The only area that seems unaffected so far is direct mail, which still seems to advertise for writers at about the same clip as they have for the past three or four years.</p>
<h3>Technical writing is still holding up</h3>
<p>Technical writing and information development positions have stayed relatively stable so far. While there are technology companies that have had to cut their budgets over the past year, I am still seeing plenty of new positions opening up and no reports of layoffs. If the recession gets worse, which I suspect it will, then you can expect that this field will dry up too. Most companies view documentation as a &#8220;nice to have&#8221; rather than a &#8220;must have&#8221;, so if the cuts start to get severe, you&#8217;ll see this job market go down as well. For now though, it is healthy.</p>
<h3>Proofreaders and editors have their own problems</h3>
<p>Proofreaders and editors are facing hiring slowdowns as well. Magazines have been failing frequently over the past year, due in equal parts to reductions in advertising and increases in both paper costs and mailing costs. On the plus side, many of them are converting to web publications, but that generally means lower paying jobs for writer, proofreaders and editors alike. <a href="http://www.sj-r.com/homepage/x1800997050/Health-care-is-bright-spot-in-Springfield-work-force">Medical</a> and legal proofreaders are still getting steady work because neither of these areas has been hit by the recession yet and there is no major expectation that they will be hit.</p>
<h3>There are some bright spots</h3>
<p>If you are looking for some bright spots, <a href="http://www.mlive.com/flintjournal/business/index.ssf/2008/08/resume_writers_keeping_busy_in.html">resume writing</a> is always a good place to find work during a recession. More and more people need good resumes as they look for work and if you know how to write resumes, you can be very helpful either as a freelancer or working for an employment agency.</p>
<p>In general, because it is such a low-paying industry, finding work writing for web sites isn&#8217;t difficult if you know what you are doing, it just doesn&#8217;t pay very well. Freelance copywriting is also still providing steady work as companies look to bypass agencies or internal writers and find lower-priced options for their copywriting needs. In general, freelancers tend to do well during a recession because many companies need things done but don&#8217;t want to hire someone permanently or go through a high-priced agency. The down side is that as people lose their jobs, more and more of them turn to freelancing so you competition increases.</p>
<h3>Bad but not terrible, yet</h3>
<p>So far, most of the writing fields are feeling the slowdown, but only newspaper writers are at a crisis point. The next year may lead to more widespread problems. The economy isn&#8217;t going to magically turn around any time soon. Next time, I&#8217;ll discuss some strategies for surviving as a writer in a down economy.</p>
<h2>Hire John Hewitt - Writing Content and Web Consulting</h2>  Email: <a href=\"mailto:hewitt@poewar.com?subject=Business Request\">hewitt@poewar.com</a><br /> Phone: (520) 261-6104<br /><a href=\"http://www.linkedin.com/in/poewar\">LinkedIn Resume</a><br /> ]]></content:encoded>
			<wfw:commentRss>http://www.poewar.com/will-the-recession-hurt-your-writing-career/feed/</wfw:commentRss>
		<slash:comments>17</slash:comments>
		</item>
		<item>
		<title>How Technical Writers Gather Information: Going to training sessions / meeting the trainers</title>
		<link>http://www.poewar.com/how-technical-writers-gather-information-going-to-training-sessions-meeting-the-trainers/</link>
		<comments>http://www.poewar.com/how-technical-writers-gather-information-going-to-training-sessions-meeting-the-trainers/#comments</comments>
		<pubDate>Wed, 27 Aug 2008 06:09:22 +0000</pubDate>
		<dc:creator>John Hewitt</dc:creator>
				<category><![CDATA[Featured]]></category>
		<category><![CDATA[Technical Writing]]></category>
		<category><![CDATA[Writing]]></category>

		<guid isPermaLink="false">http://www.poewar.com/?p=4357</guid>
		<description><![CDATA[If you want help creating documentation, get to know the trainers. I am frequently amazed at how little communication some companies have between the training and the documentation departments. In many cases, the training departments develop their own materials &#8211; existing as a completely separate unit. This can be an enormous waste of time and [...]]]></description>
			<content:encoded><![CDATA[<p><img class="alignright" style="margin: 8px; float: right;" src="http://poewar.com/images/gather.jpg" alt="Information and Coffee" width="141" height="212" />If you want help creating documentation, get to know the trainers. I am frequently amazed at how little communication some companies have between the training and the documentation departments. In many cases, the training departments develop their own materials &#8211; existing as a completely separate unit. This can be an enormous waste of time and money. More than once I have sweated over creating a procedure, only to find out later that it was already in the training materials.</p>
<p>Trainers not only get to know the company&#8217;s products, they get to know the customers. For many (shortsighted) companies, the trainers are the closest thing you have to a usability team. They walk through the product in front of the clients, who inevitably have questions about the process or come up with scenarios that point out the limitations of the product. On the flip side, documentation people frequently have information that trainers can use. I am often in the position of telling a trainer that a change in the product is coming.  For those trainers who do create their own materials, I always try to provide any editing or formatting assistance they may need.</p>
<p>I attend as many training sessions as I can fit in my schedule. I rarely turn down an opportunity, even if I have been to the training before. When possible, I record the trainings so that I can listen to them later. In some cases, company rules prevent this, but if you can record a training session, do it. One of the benefits of this is that you capture knowledge that could easily disappear if that trainer leaves the company.</p>
<p>Tips for attending trainings:</p>
<ul>
<li>Trainings can be dull. Bring a caffeinated beverage or energy drink, just in case you start to drift off.</li>
<li>Make sure you keep whatever training materials are given out, and get electronic copies if possible.</li>
<li>Invest in a digital audio recorder. You can then download audio files of training sessions directly into your computer.</li>
<li>Know your role. In some training sessions, especially client training sessions, you may need to be a silent observer. In other training sessions you will be able to ask any question you want. Check with the trainer beforehand.</li>
<li>Some trainers are willing to schedule one-on-one training sessions that you can use to take notes and ask documentation-related questions that might otherwise be distracting in a classroom. This also allows the trainer to practice in a lower-stress environment.</li>
<li>Share your own information with the trainer. Cooperation will help both groups.</li>
</ul>
<p>Does anyone else have tips that they would like to add?</p>
<p><strong>Part Four of a Series:</strong></p>
<ul>
<li><a href="http://www.poewar.com/how-technical-writers-gather-information-attending-holding-meetings/">Part One: How Technical Writers Gather Information: Attending / Holding Meetings</a></li>
<li><a rel="bookmark" href="../how-technical-writers-gather-information-interviewing-the-smes/">Part Two: How Technical Writers Gather Information: Interviewing the SMEs</a></li>
<li><a href="http://www.poewar.com/how-technical-writers-gather-information-using-the-product/?preview=true">Part Three: How Technical Writers Gather Information: Using the product</a></li>
</ul>
<h2>Hire John Hewitt - Writing Content and Web Consulting</h2>  Email: <a href=\"mailto:hewitt@poewar.com?subject=Business Request\">hewitt@poewar.com</a><br /> Phone: (520) 261-6104<br /><a href=\"http://www.linkedin.com/in/poewar\">LinkedIn Resume</a><br /> ]]></content:encoded>
			<wfw:commentRss>http://www.poewar.com/how-technical-writers-gather-information-going-to-training-sessions-meeting-the-trainers/feed/</wfw:commentRss>
		<slash:comments>3</slash:comments>
		</item>
		<item>
		<title>How Technical Writers Gather Information: Using the product</title>
		<link>http://www.poewar.com/how-technical-writers-gather-information-using-the-product/</link>
		<comments>http://www.poewar.com/how-technical-writers-gather-information-using-the-product/#comments</comments>
		<pubDate>Tue, 26 Aug 2008 06:05:03 +0000</pubDate>
		<dc:creator>John Hewitt</dc:creator>
				<category><![CDATA[Featured]]></category>
		<category><![CDATA[Technical Writing]]></category>
		<category><![CDATA[Writing]]></category>

		<guid isPermaLink="false">http://www.poewar.com/?p=4356</guid>
		<description><![CDATA[Getting to know a product is one of the keys to documenting that product. You &#8220;walk through&#8221; the various features and procedures and document them as you go. In some cases this is easy and in other cases it is difficult. Sometimes the product you are documenting does things that are outside of your level [...]]]></description>
			<content:encoded><![CDATA[<p><img class="alignright" style="margin: 8px; float: right;" src="http://poewar.com/images/gather.jpg" alt="Information and Coffee" width="141" height="212" />Getting to know a product is one of the keys to documenting that product. You &#8220;walk through&#8221; the various features and procedures and document them as you go. In some cases this is easy and in other cases it is difficult. Sometimes the product you are documenting does things that are outside of your level of experience or are based on complex sets of data and configurations.</p>
<p>For example, documenting a word processor gives you plenty of opportunities to explore. You can wotk with all of the standard features. Some of the more complex features may require specific information or applications, but every feature and is available (or should be). Additionally, because you are a writer, a word processor has you as one of its target users. Most of the features are ones that you would want to access and understand as an end user and that the applications designers would want you to access and understand.</p>
<p>Some products aren&#8217;t as easy to play with. For example, let&#8217;s say that you are documenting a program that links merchants, independent sales organizations (ISOs &#8220;eyesos&#8221;) and banks to a credit card processing system. Because you are a technical writer and thus are not a merchant, ISO, or a bank, this is not a program that has you as a target user. This means that the processes and features are not aimed at your skill set or goals. Much of the information you need to complete the tasks may not be readily available or easily replicated</p>
<p>If an application like this were being used to board an actual merchant, that merchant would have at least one merchant point-of-sale (POS) terminal to add to the system. There are dozens of different POS terminals that a merchant may choose from, and each has different data sets to be loaded. Some users may only be using the system for authorization and capture (front-end processing) while others may also use the program for clearing and settlement (back-end processing). For an extra, added level of difficulty, assume that the merchants, the ISOs and the banks all see a different version of the program, and that each may have any of 31 different configuration options that could change what they see on the screen. Also assume that you cannot use live data because that would give you access to sensitive information about a company&#8217;s finances as well as thousands of user&#8217;s credit card numbers. All of this, of course, assumes that the program is complete and operational when you are documenting it. Often features only become fully operational a week or two before the product rollout &#8211; which is about the time that the documentation is supposed to be available.</p>
<p>As you can see, while using the product is a key way to document the program, it can be difficult. Sometimes you have to use &#8220;dummy&#8221; or &#8220;scrubbed&#8221; data that has been designed to simulate the information you might actually use in the program. The problem with this is that dummy information is not real and it is not flexible. It can make accounting for every scenario difficult. In many cases, this is why you see documentation that is general and does not address all of your problems as a user. Often there are just too many scenarios and possible results to document.</p>
<p>Here are some tips to help you walk through a product:</p>
<ol></ol>
<ul>
<li>Get as much information beforehand as possible. You can often access functional designs or testing scripts that provide the process steps for you to work with.</li>
<li>Consider the different types of users a product has and the different needs those users have.</li>
<li>Try to simulate the actual user&#8217;s experiences and data as closely as possible.</li>
<li>It is often good to walk through the program with other users or SMEs so that people with the appropriate knowledge or goals are on hand.</li>
<li>Make mistakes. It is good to know what will happen if the user doesn&#8217;t do what they are expected to do.</li>
<li>Take screen shots of applications while you work with them. You may or may not be able to use them in your documentation, but at minimum you can refer to them at times when you do not have access to the product.</li>
<li>If something doesn&#8217;t function as designed, let the appropriate people know. Different companies have different processes for this, but sharing that information is vital to making the product work.</li>
<li>Try out similar products if you have access to them. It is good to see how other products work with a user&#8217;s needs.</li>
</ul>
<ol></ol>
<p>Does anyone else have any tips to add?</p>
<p><strong>Part Three of a Series:</strong></p>
<p><a href="http://www.poewar.com/how-technical-writers-gather-information-attending-holding-meetings/">Part One: How Technical Writers Gather Information: Attending / Holding Meetings</a></p>
<p><a rel="bookmark" href="../how-technical-writers-gather-information-interviewing-the-smes/">Part Two: How Technical Writers Gather Information: Interviewing the SMEs</a></p>
<h2>Hire John Hewitt - Writing Content and Web Consulting</h2>  Email: <a href=\"mailto:hewitt@poewar.com?subject=Business Request\">hewitt@poewar.com</a><br /> Phone: (520) 261-6104<br /><a href=\"http://www.linkedin.com/in/poewar\">LinkedIn Resume</a><br /> ]]></content:encoded>
			<wfw:commentRss>http://www.poewar.com/how-technical-writers-gather-information-using-the-product/feed/</wfw:commentRss>
		<slash:comments>2</slash:comments>
		</item>
		<item>
		<title>How Technical Writers Gather Information: Interviewing the SMEs</title>
		<link>http://www.poewar.com/how-technical-writers-gather-information-interviewing-the-smes/</link>
		<comments>http://www.poewar.com/how-technical-writers-gather-information-interviewing-the-smes/#comments</comments>
		<pubDate>Mon, 25 Aug 2008 17:36:12 +0000</pubDate>
		<dc:creator>John Hewitt</dc:creator>
				<category><![CDATA[Featured]]></category>
		<category><![CDATA[Technical Writing]]></category>
		<category><![CDATA[Writing]]></category>

		<guid isPermaLink="false">http://www.poewar.com/?p=4355</guid>
		<description><![CDATA[Subject Matter Experts (SMEs / Smees) are resources who have expertise in the product / subject you are documenting. Many people within a company become SMEs for various reasons. Business analysts, program analysts, engineers and designers are often the people who create the design for a product or request the changes that will be made [...]]]></description>
			<content:encoded><![CDATA[<p><img class="alignright" style="margin: 8px; float: right;" src="http://poewar.com/images/gather.jpg" alt="Information and Coffee" width="141" height="212" />Subject Matter Experts (SMEs / Smees) are resources who have expertise in the product / subject you are documenting. Many people within a company become SMEs for various reasons. Business analysts, program analysts, engineers and designers are often the people who create the design for a product or request the changes that will be made to a product, so they become SMEs. Programmers write the code that makes a product run, so they become SMEs. Trainers teach people how to use the products, so they become SMEs. Testers make sure the product operates properly, so they become SMEs. Technical support works with people to solve their problems using the product, so they become SMEs. If you spend enough time documenting the same product you may also eventually become a SME.</p>
<p>Most SMEs are technical people, but many of them are not skilled at explaining how things work. That is one of the reasons why technical writers get hired in the first place. Technical writers explain things that other people either haven&#8217;t got the skills to explain, or haven&#8217;t got the time to explain. That means the technical writer has to talk to these people and get the information out of them. This isn&#8217;t always easy, but it is generally necessary.</p>
<p>In many cases, SMEs are very busy. Getting a second meeting with them may be difficult, so prepare as much as possible for the first meeting by getting to know the subject, figuring out what questions to ask and having any necessary materials ready. Here are a few more hints to help you get the most out of a SME.</p>
<ol>
<li>Bring an audio recorder. This doesn&#8217;t eliminate the need to take notes, but it does give you a backup. Most people speak far faster than most people write, so having the recorder makes it easier to go back and get information.</li>
<li>Ask questions that get the SME to address your needs as a technical writer. Here are a few starters:
<ul>
<li>What does a first time user need to know about this?</li>
<li>What does an experienced user need to know about this?</li>
<li>What is the process for completing the task?</li>
<li>What happens if the user makes a mistake?</li>
<li>Are there any other parts of the product/documentation that will need to change because of this?</li>
</ul>
</li>
<li>Be courteous even if the SME is not. An angry SME is a real pain in the neck.</li>
<li>Bring snacks / bribes.</li>
<li>Follow up with an email that restates the information that the SME gave you so that they have a chance to make changes and so that they will not be able to claim they were misunderstood.</li>
</ol>
<p>Does anyone else have any tips to add?</p>
<p><strong>Part Two of a Series:</strong></p>
<p><a href="http://www.poewar.com/how-technical-writers-gather-information-attending-holding-meetings/">Part One: How Technical Writers Gather Information: Attending / Holding Meetings</a></p>
<h2>Hire John Hewitt - Writing Content and Web Consulting</h2>  Email: <a href=\"mailto:hewitt@poewar.com?subject=Business Request\">hewitt@poewar.com</a><br /> Phone: (520) 261-6104<br /><a href=\"http://www.linkedin.com/in/poewar\">LinkedIn Resume</a><br /> ]]></content:encoded>
			<wfw:commentRss>http://www.poewar.com/how-technical-writers-gather-information-interviewing-the-smes/feed/</wfw:commentRss>
		<slash:comments>2</slash:comments>
		</item>
	</channel>
</rss>
