<?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/"
	xmlns:series="http://unfoldingneurons.com/"
	>

<channel>
	<title>I&#039;d Rather Be Writing &#187; design reviews</title>
	<atom:link href="http://idratherbewriting.com/tag/design-reviews/feed/" rel="self" type="application/rss+xml" />
	<link>http://idratherbewriting.com</link>
	<description>The Latest Trends in Technical Communication</description>
	<lastBuildDate>Mon, 13 Feb 2012 22:26:51 +0000</lastBuildDate>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.3.1</generator>
		<item>
		<title>Directions I’m Going in 2010</title>
		<link>http://idratherbewriting.com/2010/01/04/directions-i%e2%80%99m-going-in-2010/</link>
		<comments>http://idratherbewriting.com/2010/01/04/directions-i%e2%80%99m-going-in-2010/#comments</comments>
		<pubDate>Mon, 04 Jan 2010 06:07:04 +0000</pubDate>
		<dc:creator>Tom Johnson</dc:creator>
				<category><![CDATA[blog]]></category>
		<category><![CDATA[basketball]]></category>
		<category><![CDATA[collaborative authoring]]></category>
		<category><![CDATA[design]]></category>
		<category><![CDATA[design reviews]]></category>
		<category><![CDATA[narrative]]></category>
		<category><![CDATA[new year's resolutions]]></category>
		<category><![CDATA[ownership]]></category>
		<category><![CDATA[Screencasts]]></category>
		<category><![CDATA[story]]></category>
		<category><![CDATA[Technical Writing]]></category>
		<category><![CDATA[wordpress consulting]]></category>

		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=5495</guid>
		<description><![CDATA[Given that it&#8217;s a new year, a lot of people are writing about trends and predictions in technical communication. Ellis Pratt at Cherryleaf has an interesting post on the Top 10 Trends in Technical Communication for 2010. Larry Kunz has a post on Technical Communication Trends in 2010. Sarah O&#8217;Keefe chimed in with 2010 Predictions for Technical Communication. And Ben Minson has Ten New Year&#8217;s Resolutions. ... <a href="http://idratherbewriting.com/2010/01/04/directions-i%e2%80%99m-going-in-2010/">more &#187;</a>]]></description>
			<content:encoded><![CDATA[<p>Given that it&#8217;s a new year, a lot of people are writing about trends and predictions in technical communication. Ellis Pratt at Cherryleaf has an interesting post on the <a href="http://www.cherryleaf.com/blog/2010/01/trends-in-technical-communication-in-2010-and-beyond/">Top 10 Trends in Technical Communication for 2010</a>. Larry Kunz has a post on <a href="http://www.sdicorp.com/Resources/Blog/articleType/ArticleView/articleId/63/Technical-communication-trends-in-the-2010s.aspx">Technical Communication Trends in 2010</a>. Sarah O&#8217;Keefe chimed in with <a href="http://www.scriptorium.com/blog/2010/01/2010-predictions-for-technical-communication.html" target="_blank">2010 Predictions for Technical Communication</a>. And Ben Minson has <a href="http://www.gryphonmountain.net/2010/01/ten-new-years-resolutions-for-technical-writers/" target="_blank">Ten New Year&#8217;s Resolutions</a>.</p>
<p>Rather than predict or comment on trends in our industry (which <a href="http://www.idratherbewriting.com/2009/12/23/i-find-that-youre-very-central-and-visible-responding-to-reader-questions/">I already did here</a>), I&#8217;d rather describe the <em>actual </em>directions I&#8217;m going in 2010. <span id="more-5495"></span></p>
<h3>Embrace a Collaborative Authoring Platform</h3>
<p>I&#8217;m embracing collaborative authoring this year, with plans to entitle key authors in various departments for some projects and completely open up authoring for others. More and more projects I write documentation for require input from multiple subject matter experts spread out across the organization. The days when a single writer could accurately provide help for people in a department he or she isn&#8217;t even in seem to be over. I&#8217;m planning to use Mediawiki as the collaborative platform (because it&#8217;s on the menu of approved technologies in my organization). A collaborative authoring platform will also simplify interactions and exchanges when I have teammates working on the same project.</p>
<h3>Let Customers Own the Documentation after the First Release</h3>
<p>This year I&#8217;ve noticed another trend: customers want to own the documentation after I write the first release. When this first happened (and someone requested my source files), I was offended. But the more I thought about it, the more it made sense. As I write documentation for more and more projects and departments, I&#8217;m building a larger base of documentation to maintain. I can&#8217;t be effective when I&#8217;m maintaining fifteen different projects at once while working on three new ones. I prefer to have a dedicated handful of people with authoring capabilities to help with the maintenance. That just isn&#8217;t feasible with a proprietary and costly help authoring tool (in my situation), so this direction builds on my previous point about embracing a collaborative authoring platform.</p>
<h3>Make Screencasts a Core Deliverable</h3>
<p>The best feedback I receive about my help deliverables is with the screencasts I create. I plan to continue screencasting, perhaps dipping more into dynamic visuals with Adobe After Effects or Flash. I want to further hone my audio and visual skills in this medium.</p>
<h3>Continue Team Design Reviews</h3>
<p>In our agile environment, our team is spread out across various portfolios and departments. We lose out on a lot of interaction and camaraderie, but we recently started doing some biweekly design reviews in which we get together and critique each other&#8217;s help. The design reviews have been <a href="http://blog.paulpehrson.com/2009/10/07/design-review/" target="_blank">engaging</a> and <a href="http://www.gryphonmountain.net/2008/07/team-documentation-design-reviews/" target="_blank">worthwhile</a> – I hope we continue them regularly into 2010.</p>
<h3>Participate More in Design</h3>
<p>One of the situations I dislike is 9<sup>th</sup> inning documentation. At this stage, the interface is frozen and I&#8217;ve been such a stranger to the project that the PM isn&#8217;t looking at me for any input other than to document &#8220;what is.&#8221; Instead, I&#8217;d like to make it my standard to get involved around the 4<sup>th</sup> or 5<sup>th</sup> inning so that I can contribute more to the interface and task flow. One reason I haven&#8217;t been able to jump in this early is because I&#8217;m so busy maintaining documentation for numerous projects that are in their second or third release cycles. Getting involved early with the design and earning a seat at the design table will require me to prove my worth, certainly, since we already have a fair number of interaction designers, business analysts, and project managers who perform this role.</p>
<h3>More Story-Driven Blog Posts</h3>
<p>On my blog, I plan to write more story-driven posts. I get more response and fulfillment from blog posts with well-crafted narratives than I do anything else. My daughter recently listened to about 12 hours of <a href="http://storynory.com" target="_blank">Storynory</a> podcasts straight because of the mesmerizing power of story. I want to develop my skill at seeing story and building narratives that engage audiences.</p>
<h3>More WordPress Consulting</h3>
<p>I was a bit wishy-washy this year as to whether I would continue <a href="http://idratherbewriting.com/wordpress-consulting">WordPress consulting</a> or not, given the time it consumes. But I love working with websites, and the extra money helps, so I plan to do even more WordPress consulting in 2010. If I get too much work, I&#8217;ll outsource some of the development (I already outsourced much of it last year). This year I&#8217;m specializing in <a href="http://woothemes.com" target="_blank">Woothemes</a> more, since it seems to simplify the client&#8217;s decision-making process with themes.</p>
<h3>More Basketball</h3>
<p>For many years I&#8217;ve felt guilty about playing basketball. Compared to other forms of exercise, basketball takes three times as long, causes me to stay up too late, and seems to be an inefficient way to get exercise. But I&#8217;ve finally decided to succumb to it, because I love playing it and because life in IT is so <a href="http://www.idratherbewriting.com/2007/07/21/tips-for-avoiding-the-sedentary-lifestyle-even-when-you-work-in-it/">sedentary</a>. This goal feeds into my overall New Year&#8217;s resolutions to do more of what I love.<br />
<h2>Blog Sponsors</h2>
<ul>
<li><a href="http://webworks.com">Webworks ePublisher</a></li>
<li><a href="http://scriptorium.com">Scriptorium</a></li>
<li><a href="http://www.helpgenerator.com">Help Generator help authoring software</a></li>
<li><a href="http://idc.spsu.edu">Southern Polytechnic: Information Design and Communication</a></li>
<li><a href="http://simplifiedenglish.net">Simplified English</a></li>
<li><a href="http://info.mindtouch.com/irbw/tcs-custom-tour?persona=content">MindTouch</a></li>
<li><a href="http://www.madcapsoftware.com/products/madpak/overview.aspx?utm_source=IdRatherBeWriting&#038;utm_medium=Banner&#038;utm_campaign=MadPak"</a>Madcap Software</a></li>
<li><a href="http://www.drexplain.com/">Dr.Explain</a> </li>
<li><a href="http://www.adobe.com/products/technicalcommunicationsuite/try.html?sdid=ITRSO">Adobe Technical Communication Suite</a></li>
<li><a href="http://www.congree.com/en/download-congree-personal-edition.aspx">Congree</a></li>
</ul>
]]></content:encoded>
			<wfw:commentRss>http://idratherbewriting.com/2010/01/04/directions-i%e2%80%99m-going-in-2010/feed/</wfw:commentRss>
		<slash:comments>8</slash:comments>
		</item>
		<item>
		<title>Design Reviews and Posting Without Answers</title>
		<link>http://idratherbewriting.com/2009/11/08/design-reviews-and-posting-without-answers/</link>
		<comments>http://idratherbewriting.com/2009/11/08/design-reviews-and-posting-without-answers/#comments</comments>
		<pubDate>Mon, 09 Nov 2009 01:07:22 +0000</pubDate>
		<dc:creator>Tom Johnson</dc:creator>
				<category><![CDATA[blog]]></category>
		<category><![CDATA[answers]]></category>
		<category><![CDATA[collaboration]]></category>
		<category><![CDATA[community]]></category>
		<category><![CDATA[design reviews]]></category>
		<category><![CDATA[team]]></category>
		<category><![CDATA[Technical Writing]]></category>

		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=4995</guid>
		<description><![CDATA[Recently our technical writing team at work (Information Strategies and Design) started holding regular design reviews. The review sessions are patterned after meetings that our interaction designers hold regularly, in which they get together and critique each others designs and approaches toward user interfaces. In our design review sessions, a couple of members from our eight-person team share what they&#8217;re working on and ask questions ... <a href="http://idratherbewriting.com/2009/11/08/design-reviews-and-posting-without-answers/">more &#187;</a>]]></description>
			<content:encoded><![CDATA[<p>Recently our technical writing team at work (Information Strategies and Design) started holding regular design reviews. The review sessions are patterned after meetings that our interaction designers hold regularly, in which they get together and critique each others designs and approaches toward user interfaces.</p>
<p>In our design review sessions, a couple of members from our eight-person team share what they&#8217;re working on and ask questions about challenges they&#8217;re facing. We provide feedback and critique their project.</p>
<p>These design review sessions are one of the coolest things we&#8217;ve done as a team. We don&#8217;t have a strict team style guide or set of standard deliverables. (We do follow the Microsoft Style Guide and, at times, a thin organizational style guide.) But as far as branding the help material, there can be a lot of variation among the online help files, quick reference guides, landing pages, context-sensitive help, interface text, e-learning, video tutorials, or other help materials we create.<a title="NaNoWriMo and NaBloPoMo Start Nov 1" href="../2009/11/01/nanowrimo-and-nablopomo-start-nov-1/"> </a></p>
<p>If you&#8217;ve ever participated in a creative writing group, the design review works similarly. Team members use common sense and experience to guide their questions and reviews. Somewhat in contrast to a creative writing group, though, you don&#8217;t have to bring a finished piece to share.<br />
<span id="more-4995"></span><br />
For example, the other week I was coordinating who would share materials for our design review, and one of our team members told me he wasn&#8217;t ready to show it. What? I said. The design review is not about showing finished material. It&#8217;s better, in fact, to show what you&#8217;re currently working on, while it&#8217;s still early in the process, before you&#8217;ve cemented everything. Oh, he said. In that case, yes.</p>
<h3>Parallels with Blogging</h3>
<p>I find that the same mindset works with blogging as well. Often times we think we can&#8217;t publish a post until we&#8217;ve finished a cool thought, or until we&#8217;ve finalized a solution to something. But this past week, I added a couple of posts in which I wasn&#8217;t quite sure what I thought. In my <a href="http://www.idratherbewriting.com/2009/11/05/theme-parks-and-external-and-internal-input/">Theme Parks and External and Internal Input post</a>, I was only part way into a thought. Commenters added to the discussion and helped me better see insights and perspectives on the issue.</p>
<p>I also wrote a post on working with wikis, <a href="http://www.idratherbewriting.com/2009/10/29/a-few-surprises-in-using-a-wiki-for-documentation/">A Few Surprises in Using a Wiki for Documentation</a>. I&#8217;m not an expert on wikis, especially Mediawiki, and there are many things about wiki authoring that I need to learn. But this didn&#8217;t stop me from posting about it. Instead, I shared some of the challenges and issues I was facing. And some of the commenters added information that proved incredibly helpful. For example, see this <a href="http://www.idratherbewriting.com/2009/10/29/a-few-surprises-in-using-a-wiki-for-documentation/comment-page-1/#comment-145930">informative comment by Amalia</a>.</p>
<p>Had I waited until I finished in putting together an entire strategy and methodology for authoring on Mediawiki before posting about it, I would have missed out on the guidance and direction early on. It&#8217;s from the helpful information early in the process, particularly with challenges I&#8217;m facing, that comments on a blog become the most useful. A blog is, remember, a journal, so it contains thoughts and ideas and experiments <em>in progress</em> &#8212; not always finished solutions, completed ideas, or tried-and-true methodologies.</p>
<p>What&#8217;s true in design review is just as true in blogging. Sharing the current challenges you&#8217;re facing will make your experience in the blogosphere or design review process more helpful and rewarding.<br />
<h2>Blog Sponsors</h2>
<ul>
<li><a href="http://webworks.com">Webworks ePublisher</a></li>
<li><a href="http://scriptorium.com">Scriptorium</a></li>
<li><a href="http://www.helpgenerator.com">Help Generator help authoring software</a></li>
<li><a href="http://idc.spsu.edu">Southern Polytechnic: Information Design and Communication</a></li>
<li><a href="http://simplifiedenglish.net">Simplified English</a></li>
<li><a href="http://info.mindtouch.com/irbw/tcs-custom-tour?persona=content">MindTouch</a></li>
<li><a href="http://www.madcapsoftware.com/products/madpak/overview.aspx?utm_source=IdRatherBeWriting&#038;utm_medium=Banner&#038;utm_campaign=MadPak"</a>Madcap Software</a></li>
<li><a href="http://www.drexplain.com/">Dr.Explain</a> </li>
<li><a href="http://www.adobe.com/products/technicalcommunicationsuite/try.html?sdid=ITRSO">Adobe Technical Communication Suite</a></li>
<li><a href="http://www.congree.com/en/download-congree-personal-edition.aspx">Congree</a></li>
</ul>
]]></content:encoded>
			<wfw:commentRss>http://idratherbewriting.com/2009/11/08/design-reviews-and-posting-without-answers/feed/</wfw:commentRss>
		<slash:comments>1</slash:comments>
		</item>
	</channel>
</rss>

