<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" media="screen" href="/~d/styles/atom10full.xsl"?><?xml-stylesheet type="text/css" media="screen" href="http://feeds.feedburner.com/~d/styles/itemcontent.css"?><feed xmlns="http://www.w3.org/2005/Atom" xmlns:thr="http://purl.org/syndication/thread/1.0" xml:lang="en" xml:base="http://www.onemanwrites.co.uk/wp-atom.php">
	<title type="text">one man writes</title>
	<subtitle type="text">musings on technical communications</subtitle>

	<updated>2009-11-04T08:53:40Z</updated>
	<generator uri="http://wordpress.org/" version="2.8.5">WordPress</generator>

	<link rel="alternate" type="text/html" href="http://www.onemanwrites.co.uk" />
	<id>http://www.onemanwrites.co.uk/feed/atom/</id>
	

			<link rel="self" href="http://feeds.feedburner.com/onemanwrites" type="application/atom+xml" /><feedburner:emailServiceId xmlns:feedburner="http://rssnamespace.org/feedburner/ext/1.0">onemanwrites</feedburner:emailServiceId><feedburner:feedburnerHostname xmlns:feedburner="http://rssnamespace.org/feedburner/ext/1.0">http://feedburner.google.com</feedburner:feedburnerHostname><atom10:link xmlns:atom10="http://www.w3.org/2005/Atom" rel="hub" href="http://pubsubhubbub.appspot.com" /><entry>
		<author>
			<name>Gordon McLean</name>
						<uri>http://onemanwrites.co.uk/</uri>
					</author>
		<title type="html"><![CDATA[On taking notes]]></title>
		<link rel="alternate" type="text/html" href="http://www.onemanwrites.co.uk/2009/11/04/on-taking-notes/" />
		<id>http://www.onemanwrites.co.uk/?p=477</id>
		<updated>2009-11-04T08:53:40Z</updated>
		<published>2009-11-04T08:53:40Z</published>
		<category scheme="http://www.onemanwrites.co.uk" term="General" /><category scheme="http://www.onemanwrites.co.uk" term="Information" />		<summary type="html"><![CDATA[
I have been remiss at writing new content for this blog, and whilst this topic isn&#8217;t one that I said I&#8217;d post about (those posts are coming, I promise), it&#8217;s something I was discussing yesterday and so is at the forefront of my mind.
Like many people I still use pen and paper when taking notes, [...]]]></summary>
		<content type="html" xml:base="http://www.onemanwrites.co.uk/2009/11/04/on-taking-notes/"><![CDATA[<p><a href="http://www.onemanwrites.co.uk/blog/wp-content/uploads/2009/11/cu_home_taking_notes.jpg"><img src="http://www.onemanwrites.co.uk/blog/wp-content/uploads/2009/11/cu_home_taking_notes.jpg" alt="cu_home_taking_notes" title="cu_home_taking_notes" width="500" class="alignleft size-full wp-image-478" /></a></p>
<p>I have been remiss at writing new content for this blog, and whilst this topic isn&#8217;t one that I said I&#8217;d post about (those posts are coming, I promise), it&#8217;s something I was discussing yesterday and so is at the forefront of my mind.</p>
<p>Like many people I still use pen and paper when taking notes, and regardless of the type of meeting I stick with three basic categories.</p>
<ol>
<li><strong>[] Actions</strong> either for me or my team to do. Includes things that need done immediately or things which it would be good to do in the future.</li>
<li><strong>? Questions</strong> on things I want to learn more about, which relate to my team. Whilst these may also be actions (typically they involve asking people questions) I differentiate them because, until I&#8217;ve asked the question, I don&#8217;t know enough to decide on whether there is anything to be done (caveat: if it is a burning issue, I&#8217;ll like put this against both categories <strong>? []</strong> ).</li>
<li><strong>I Information</strong> which covers all sorts of things from useful URLs, to quotes, to product names and so on. </li>
</ol>
<p>I also &#8220;style&#8221; my notes, with the appropriate shorthand symbol first, then a gap, then the text for that item. Keeping that consistent makes it very easy to scan down my notes to process them. </p>
<p><strong>[]</strong> email report to Fred<br />
<strong>[]</strong> speak to Tina about next phase of work<br />
<strong>?</strong> what is the cognitive learning project, who is running it?<br />
<strong>[]</strong> write a blog post on the Information Strategy Pyramid<br />
<strong>I</strong> stats for last week 103 open, 74 closed</p>
<p>Processing the notes, again, depends on the type of note.</p>
<p>For actions as, unless they can be done straight away (I think that is a GTD methodology thing? If it takes 1 minute to do it, and 1 minute to write it up and put it in a list, then you are better just doing it), they are transcribed into an online task manager application I use called Remember the Milk. It has a very nice iPhone app which makes it easy to &#8220;take my list&#8221; with me at all times.</p>
<p>Questions are simply a matter of being asked. That may drive further actions or information which are captured accordingly.</p>
<p>Anything I&#8217;ve noted down as information is either processed electronically, if it&#8217;s something online I&#8217;ll visit it and either bookmark it in my <a href="http://delicious.com/snowgoon">del.icio.us</a> account, add it to my list on <a href="http://www.instapaper.com/u">Instapaper</a> (again, which has an excellent iPhone app), or grab it and store for later in <a href="http://www.evernote.com">Evernote</a> (again, a useful iPhone app helps).</p>
<p>Whilst all of that seems like a lot of work, it&#8217;s very maintainable, and I spend less than 20 mins a day processing my notes. However it helps me keep on top of several different streams of work, and so far it hasn&#8217;t let me down. I&#8217;ve been using the shorthand symbols for a long time now, but obviously the electronic processing of these things is new.</p>
<p>So, what about you? How do you take notes? Are you a mindmapper? A random scribbler? Or do you, like one lady who attend a presentation I did a few years ago, do you <a href="http://www.flickr.com/photos/gmclean/107144864/">draw out the subject and the notes in one go</a>?</p>
]]></content>
		<link rel="replies" type="text/html" href="http://www.onemanwrites.co.uk/2009/11/04/on-taking-notes/#comments" thr:count="3" />
		<link rel="replies" type="application/atom+xml" href="http://www.onemanwrites.co.uk/2009/11/04/on-taking-notes/feed/atom/" thr:count="3" />
		<thr:total>3</thr:total>
	</entry>
		<entry>
		<author>
			<name>Gordon McLean</name>
						<uri>http://onemanwrites.co.uk/</uri>
					</author>
		<title type="html"><![CDATA[What next?]]></title>
		<link rel="alternate" type="text/html" href="http://www.onemanwrites.co.uk/2009/10/29/what-next/" />
		<id>http://www.onemanwrites.co.uk/?p=464</id>
		<updated>2009-10-29T21:32:53Z</updated>
		<published>2009-10-29T21:32:53Z</published>
		<category scheme="http://www.onemanwrites.co.uk" term="Information" /><category scheme="http://www.onemanwrites.co.uk" term="Single Source" /><category scheme="http://www.onemanwrites.co.uk" term="Theory" />		<summary type="html"><![CDATA[Last night, around 3am, I woke up. I lay there in bed wondering why I&#8217;d woken up and as my mind started to churn I realised I was very very awake.
In flooded four things I&#8217;ve been thinking about for some time, all of which are related but I couldn&#8217;t quite make the connection. Last night [...]]]></summary>
		<content type="html" xml:base="http://www.onemanwrites.co.uk/2009/10/29/what-next/"><![CDATA[<p>Last night, around 3am, I woke up. I lay there in bed wondering why I&#8217;d woken up and as my mind started to churn I realised I was very very awake.</p>
<p>In flooded four things I&#8217;ve been thinking about for some time, all of which are related but I couldn&#8217;t quite make the connection. Last night I cracked it. Maybe.</p>
<p>I&#8217;m still thinking it through but here are the four items in question:</p>
<ol>
<li>Single sourcing our documentation &#8211; and recent discussions with other areas of the company who could benefit from the same approach.</li>
<li>Company Information Strategy &#8211; a simple pyramid based model that allows everyone creating content to &#8216;map&#8217; their audience appropriately and which should start to help with consistency of terminology and messaging.</li>
<li>Document Management &#8211; there have been some murmurings about this from a few people and it&#8217;s likely to fall into my lap.</li>
<li>Requirements gathering &#8211; we&#8217;ve recently rolled out a new process which should lead to better requirements for each project build.</li>
</ol>
<p>All of these are tied together, and if planned properly can feed off each other. Naturally there is quite a lot involved with all of the above and I&#8217;ll be revisiting items one and two in the coming weeks.</p>
<p>Ohh and I&#8217;ve still to pull together a slide deck on &#8220;selling our services&#8221;, which involves all of the above and more. Once it&#8217;s ready, I&#8217;ll share it here. </p>
<p>Exciting times ahead.</p>
]]></content>
		<link rel="replies" type="text/html" href="http://www.onemanwrites.co.uk/2009/10/29/what-next/#comments" thr:count="1" />
		<link rel="replies" type="application/atom+xml" href="http://www.onemanwrites.co.uk/2009/10/29/what-next/feed/atom/" thr:count="1" />
		<thr:total>1</thr:total>
	</entry>
		<entry>
		<author>
			<name>Gordon McLean</name>
						<uri>http://onemanwrites.co.uk/</uri>
					</author>
		<title type="html"><![CDATA[Author-it &amp; Word]]></title>
		<link rel="alternate" type="text/html" href="http://www.onemanwrites.co.uk/2009/10/27/author-it-word/" />
		<id>http://www.onemanwrites.co.uk/?p=462</id>
		<updated>2009-10-27T11:54:58Z</updated>
		<published>2009-10-27T11:54:58Z</published>
		<category scheme="http://www.onemanwrites.co.uk" term="Author-it" />		<summary type="html"><![CDATA[A teeny tiny gotcha that I thought I&#8217;d mention here. I can&#8217;t find explicit mention of it in the Author-it Knowledge Center and it&#8217;s tripped me up a bit.
Quite simply, and I realise these will sound obvious, make sure everyone who is using Author-it is using the same version of Microsoft Word. 
My particular scenario [...]]]></summary>
		<content type="html" xml:base="http://www.onemanwrites.co.uk/2009/10/27/author-it-word/"><![CDATA[<p>A teeny tiny gotcha that I thought I&#8217;d mention here. I can&#8217;t find explicit mention of it in the Author-it Knowledge Center and it&#8217;s tripped me up a bit.</p>
<p>Quite simply, and I realise these will sound obvious, make sure everyone who is using Author-it is using the same version of Microsoft Word. </p>
<p>My particular scenario has my laptop running Word 2007, making changes to the template, but when publishing from a machine running Word 2003, the footers weren&#8217;t being displayed despite the AutoText entry being available in the output Word document.</p>
<p>Naturally I&#8217;m discovering this delightful quirk on the final day of the project as we do a final publish and check on our deliverables. And people wonder why I&#8217;m almost bald&#8230;</p>
]]></content>
		<link rel="replies" type="text/html" href="http://www.onemanwrites.co.uk/2009/10/27/author-it-word/#comments" thr:count="2" />
		<link rel="replies" type="application/atom+xml" href="http://www.onemanwrites.co.uk/2009/10/27/author-it-word/feed/atom/" thr:count="2" />
		<thr:total>2</thr:total>
	</entry>
		<entry>
		<author>
			<name>Gordon McLean</name>
						<uri>http://onemanwrites.co.uk/</uri>
					</author>
		<title type="html"><![CDATA[Dumping the manual]]></title>
		<link rel="alternate" type="text/html" href="http://www.onemanwrites.co.uk/2009/10/20/dumping-the-manual/" />
		<id>http://www.onemanwrites.co.uk/?p=460</id>
		<updated>2009-10-20T07:46:08Z</updated>
		<published>2009-10-20T07:46:08Z</published>
		<category scheme="http://www.onemanwrites.co.uk" term="InfoDesign" /><category scheme="http://www.onemanwrites.co.uk" term="Theory" />		<summary type="html"><![CDATA[I honestly can&#8217;t remember the last time I picked up a user manual, an honest-to-god paper book of technical documentation. Actually that&#8217;s a lie, it was just last week when i was tidying up. I picked up several user manuals and moved them to a lower shelf on my bookcase.
It&#8217;s also been a long time [...]]]></summary>
		<content type="html" xml:base="http://www.onemanwrites.co.uk/2009/10/20/dumping-the-manual/"><![CDATA[<p>I honestly can&#8217;t remember the last time I picked up a user manual, an honest-to-god paper book of technical documentation. Actually that&#8217;s a lie, it was just last week when i was tidying up. I picked up several user manuals and moved them to a lower shelf on my bookcase.</p>
<p>It&#8217;s also been a long time since I last worked for a company that produce and printed user manuals but that&#8217;s more to do with my career path than any decisions I made within those companies. </p>
<p>Even now whilst we have a &#8220;documentation set&#8221; comprising several different user manuals, it&#8217;s published to PDF and made available as part of the product distribution (and also online).</p>
<p>So why do we still maintain this view of how information should be provided?</p>
<p>There is a level of comfort in having a table of contents and a structure to the information available when writing technical information. It allows you to make sure all the required information is in place, but most of the research I&#8217;ve read, and most of the anecdotal evidence I&#8217;ve heard, suggests that those lovingly created table of contents are not heavily used.</p>
<p>The index is another area, hell it&#8217;s another profession altogether, that we spend a lot of time crafting and rightly so as it is used by many people to navigate their way through a document.</p>
<p>But one thing that trumps both of these methods isn&#8217;t available in printed documents but is widely available for online information. Search.</p>
<p>OK, so none of what I&#8217;m saying is new, or revolutionary, far from it. Those of us who have been creating online help, regardless of the format (a lot of which was before the internet was popularised), know that if there is a search option available, it will be used.</p>
<p>With that in mind, and this is most definitely something we will be consulting with our users about, we are toying with the idea of dumping the index and the table of contents, making sure the content has a good set of internal reference links so users (power and novice alike) can find &#8220;paths&#8221; through the information, and switching the front page to be a Google-esque search. </p>
<p>Luckily we can pilot this approach whilst still producing the Javahelp, PDFs and HTML (Webhelp in Author-it terms) output so we don&#8217;t completely alienate our users. It&#8217;ll be interesting to see outcome.</p>
]]></content>
		<link rel="replies" type="text/html" href="http://www.onemanwrites.co.uk/2009/10/20/dumping-the-manual/#comments" thr:count="9" />
		<link rel="replies" type="application/atom+xml" href="http://www.onemanwrites.co.uk/2009/10/20/dumping-the-manual/feed/atom/" thr:count="9" />
		<thr:total>9</thr:total>
	</entry>
		<entry>
		<author>
			<name>Gordon McLean</name>
						<uri>http://onemanwrites.co.uk/</uri>
					</author>
		<title type="html"><![CDATA[Selling ourselves]]></title>
		<link rel="alternate" type="text/html" href="http://www.onemanwrites.co.uk/2009/10/15/selling-ourselves/" />
		<id>http://www.onemanwrites.co.uk/?p=458</id>
		<updated>2009-10-15T08:32:29Z</updated>
		<published>2009-10-15T08:32:29Z</published>
		<category scheme="http://www.onemanwrites.co.uk" term="Profession" />		<summary type="html"><![CDATA[Like many, I struggle at times with a common perception, one which was highlighted to me yesterday by a colleague.
Like most team leads/managers, I have a lot of tasks that aren&#8217;t purely focussed on the creation of information. I don&#8217;t do much technical writing, instead letting the guys in my team focus on that (they [...]]]></summary>
		<content type="html" xml:base="http://www.onemanwrites.co.uk/2009/10/15/selling-ourselves/"><![CDATA[<p>Like many, I struggle at times with a common perception, one which was highlighted to me yesterday by a colleague.</p>
<p>Like most team leads/managers, I have a lot of tasks that aren&#8217;t purely focussed on the creation of information. I don&#8217;t do much technical writing, instead letting the guys in my team focus on that (they are better at it than me anyway) whilst I work around the edges of what they do, things like taking a document through a review with some SMEs and processing the output, or building a new output template, or proof reading some of their work.</p>
<p>My team and I have a good idea of what I do, even though I also get dragged into chats about other information related initiatives (document management systems being the latest). But as far as everyone else in the organisation goes, I am obviously not doing a good enough job communicating that out.</p>
<p>So my colleague was asking how my team were doing as we are approaching the last few weeks of this current release cycle. When I said that it was a bit tight and we were probably going to have to move some of the &#8216;could have&#8217; information, he asked why and then asked what I was working on myself.</p>
<p>Thankfully, to answer his question I have a whiteboard directly behind me that holds all the &#8216;other&#8217; stuff that technical writing teams need to think about; Product Glossary updates, creation of a Knowledge Centre, Release Notes and so on.</p>
<p>However the point here is that, whilst we all struggle to convey the importance of what we do (until people get to that &#8220;ahhhhh&#8221; point which most do eventually), it is in all our interests to evangelise our services. Yes this will only have direct impact within your current organisation but the ripple effect over the coming years will start to grow as people move on and take your messages with them.</p>
<p>It may mean that you, and your team, need to stand up in front of the whole company to &#8216;introduce&#8217; themselves and what they do (same applies for lone writers!), as well as backing that up with updates and conversations with people you may not normally chat to, and I realise it&#8217;s probably not something that comes naturally to many people.</p>
<p>So to give you a kick start, as soon as I&#8217;ve finished it, I&#8217;ll be sharing a sanitised version of that very presentation. It&#8217;ll be focussed on a software company which is being re-introduced to that wee team they all know of, but don&#8217;t know much about. I hope it might be of some use.</p>
]]></content>
		<link rel="replies" type="text/html" href="http://www.onemanwrites.co.uk/2009/10/15/selling-ourselves/#comments" thr:count="1" />
		<link rel="replies" type="application/atom+xml" href="http://www.onemanwrites.co.uk/2009/10/15/selling-ourselves/feed/atom/" thr:count="1" />
		<thr:total>1</thr:total>
	</entry>
	</feed>
