<?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>Between the Lines &#187; Margaret</title>
	<atom:link href="http://swo-btlines.com/author/margaret/feed/" rel="self" type="application/rss+xml" />
	<link>http://swo-btlines.com</link>
	<description>Chapter Newsletter for STC-SWO</description>
	<lastBuildDate>Mon, 24 Oct 2011 23:57:49 +0000</lastBuildDate>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.2.1</generator>
		<item>
		<title>Writing Great Technical Documents</title>
		<link>http://swo-btlines.com/writing-great-technical-documents/</link>
		<comments>http://swo-btlines.com/writing-great-technical-documents/#comments</comments>
		<pubDate>Sat, 06 Dec 2008 02:33:12 +0000</pubDate>
		<dc:creator>Margaret</dc:creator>
				<category><![CDATA[December Issue]]></category>
		<category><![CDATA[Writing]]></category>

		<guid isPermaLink="false">http://swo-btlines.com/?p=233</guid>
		<description><![CDATA[Learn How in Six Weeks by Margaret VanWinkle &#8220;Writing great technical documents&#8221; is our goal as professional technical communicators. That is also the name of a six-week on-line continuing education course that I recently completed. The course introduction promised to help us write with confidence, recognize and overcome common writing problems, and revise our writing [...]]]></description>
			<content:encoded><![CDATA[<p></p><h3>Learn How in Six Weeks</h3>
<p>by <em><a onClick="window.open('/wp-content/images/bios/vanwinkle.html','Margaret_VanWinkle','top=400,left=220,width=435,height=185,resize=no,scrollbars=no,toolbars=no,menubar=no'); return false" href="javascript:void(0);">Margaret VanWinkle</a></em></p>
<p style="float: left; margin-top: 0px;"><img hspace="10" alt="" src="http://www.swo-btlines.com/wp-content/uploads/2008/12/techdocs.jpg" /></p>
<p>&ldquo;Writing great technical documents&rdquo; is our goal as professional technical communicators. That is also the name of a six-week on-line continuing education course that I recently completed.</p>
<p>The course introduction promised to help us write with confidence, recognize and overcome common writing problems, and revise our writing to achieve more power and clarity. That&rsquo;s quite a promise.</p>
<p>Since I&#8217;m a natural skeptic, I was surprised and delighted to see the promise fulfilled.</p>
<p><strong>Content</strong></p>
<p>Do you know the definition of an &ldquo;inkhorn term&rdquo;? Do you know how to form plurals of acronyms? Can you recognize a &ldquo;circumlocution&rdquo; or a &ldquo;hedge word&rdquo;? Do you know how to design a chart appropriate to the data being presented? Do you know how to design a document for both managers and technical readers?</p>
<p>The instructor covered these and many other topics. She opened with a fascinating review of historical writing and went on to discuss different writing styles and audiences. She then expanded to words, sentences, paragraphs, and documents.</p>
<p>The final lessons covered punctuation, graphical elements, document design, and formatting specific types of technical documents.</p>
<p><strong>Course Structure</strong><br />
Lessons were released each Wednesday and Friday, and each lesson site remained open for two weeks. The instructor provided relevant and concise responses to our questions in the chat room at least once a day (except for weekends and holidays).</p>
<p>Each lesson consisted of 4&ndash;5 chapters, a list of supplementary material, a writing assignment, and a quiz.</p>
<ul>
<li>The supplementary materials list included both reference books and pertinent articles from a variety of internet sources.</li>
<li>Writing assignments provided an opportunity to post a writing sample that other students critiqued. The instructor then critiqued the original writing sample and the other students&rsquo; critiques. This provided a real-life opportunity to give and receive constructive criticism.</li>
<li>Quizzes could be re-taken until a grade of 100% was received. The quizzes did not count toward the final grade.</li>
</ul>
<p>The final exam consisted of 36 multiple-choice questions and could not be re-taken. A Certificate of Completion was immediately issued if a passing grade was obtained (approximately 70%; the exact percentage is stated at the beginning of the exam).</p>
<p><strong>Website, Cost, &amp; Other Details</strong><br />
I discovered the course through the continuing education listing from my local community college (Clark State Community College in Springfield, Ohio, www.ed2go.com/cscc).</p>
<p>The course is also available through www.ed2go.com. Before you rush to this site, I would alert you that it actually cost twenty dollars more to enroll through the website ($129 in the summer of 2008) than through Clark State (currently $99). You may want to look at Clark State or a local community college for similar courses before enrolling through www.ed2go.com.</p>
<p>The instructor also offers a basic course called &ldquo;Fundamentals of Technical Writing&rdquo;. Since I had been a technical writer for the prior two years, I chose the advanced course. If you are thinking about entering the field, the basic course may be more appropriate.</p>
<p><strong>In Summary</strong><br />
As the course progressed, I found myself anticipating the release of each new lesson and facing work on Monday mornings with excitement. I think it is safe to say that this is the first time I have regretted seeing a course end.</p>
<p>I now know that an &ldquo;inkhorn term&rdquo; is a word created during the Renaissance by common people who wanted to appear more educated. I watch my plurals, I avoid circumlocutions and hedge words, and I create charts appropriately. I have increased confidence in my ability to design a project with all the necessary elements.</p>
<p>Technical writing may be &ldquo;dry&rdquo;, but it does not have to be stilted and boring. I came away from this course with a renewed delight in writing and an awareness of the inherent joy in communicating well.</p>
]]></content:encoded>
			<wfw:commentRss>http://swo-btlines.com/writing-great-technical-documents/feed/</wfw:commentRss>
		<slash:comments>0</slash:comments>
		</item>
	</channel>
</rss>

