bookmark_borderRecently Read

With the TICAD conference last week, a couple of days in my sick bed, and the imminent product release I’m working towards, I’ve not had a lot of time to post here. However, the RSS feeds keep trickling in, so here are a few items that caught my eye over the past couple of weeks.

What Beautiful HTML Code Looks Like
I’m a terrible coder. Which is just as well because I’m not a developer but as I do dabble in HTML and CSS quite frequently (hey, and PHP too), then this is a good reminder for me to develop my own best practises.

Code is Tabbed into Sections: If each section of code is tabbed in once, the structure of the code is much more understandable. Code that is all left-justified is horrific to read and understand.

Includes a neat infographic, downloadable as PDF, which is now pinned beside my desk.

Procedures: The Sacred Cow Blocking the Road
An update on a (yipes) 10 year old article. I don’t think I read it when it was first published but I have read it. Well worth another visit though.

“It takes a surprisingly short amount of time for a user to feel unstuck. When I was a usability consultant, I used to advise clients to put the critical information in the first three words of a sentence.”

IA Deliverables
From Content Surveys, to wireframes, Personas and Use Cases, a brief overview of each is followed by a sample template. Not only a useful resource but a good overview of the typical process an Information Architect will undertake, a lot of which can be adapted to more traditional product documentation.

Collaboration is not a dirty word
Collaboration on content (not documents, even if that is where the content ends up) was a key part of my presentation. It’s good to see the switch from document-centric to info-centric taking place.

I love things being this easy. I love getting (almost) zero emails with attachments. I love not having a hard drive full of Word documents.

DITA Troubleshooting specialization

The Troubleshooting specialization creates a new topic type that is well-suited for problem-solution information.

7 Ways to keep the post-conference buzz
Not long back from a conference myself, I have already done a few of these things (item 3 in particular) but some good ideas here.

Wikis for Documentation?
Steve Manning isn’t sure about using Wikis for Documentation but does think they could be a big hit in another, related area:

Most writers have to guess about their users. Few writers get the opportunity to speak directly with users. Few get any sort of feedback at all. They are left to do their best. How useful would it be to be able to post your document on a Wiki and have users be able to comment topic-by-topic? To see the questions they ask?

I totally agree. All I need to do is figure out how this works within a single source environment, and tackle a few issues around governance and change management and it could be an excellent working model.

And finally…
I’ll be updating the TechComms RSS feeds download soon, so if you think you should be on the list (or even if you aren’t sure whether you are or not) then let me know. It includes all kinds of stuff which is loosely related to Technical Communications, and I’m always on the lookout for more sources of inspiration. Leave a comment if you think of anything.

bookmark_borderThe Architects of Information

I’m a member of the Information Architecture Institute (IAI) but I’m still not really sure why.

I joined about a year ago, although I’d been following the website and reading articles in this area for some time before that. During that time I developed a sense that, at a fundamental level, there is a lot of crossover of knowledge and approach between practitioners of Information Architecture and those of us in the land of technical communications.

The IAI website states that:

As the information age rolls forward, our businesses, markets and societies are being transformed into adaptive, connected networks. The Internet of today only hints at the ubiquitous communication infrastructure of tomorrow. The construction of this brave new world requires a new kind of architecture, focused on digital structures of information and software rather than physical structures of bricks and mortar. As we spend more time working and playing in these shared information spaces, people will need and demand better search, navigation and collaboration systems.

Whilst a lot of the work of an IA is focussed on the web, the basic principles of good design hold true regardless of the medium. Given that many technical communicators provide online help which may, or may not, be delivered in a web format or via the web itself (as opposed to viewed locally in a web browser) those same principles can be used here. Even if we consider the production of information for print, the same considerations of information access and structure, personas and task analysis, require a level of understanding and design in which both IAs and Tech Writers specialise.

As an aside, this type of thing is one reason why you should hire a professional Technical Writer and not rely on other people in your organisation “filling the gap”. They may be able to write acceptable english, but information is next to useless if badly structured.

Looking further into the lair of an IA, we find many are now involved in what is commonly known as the “social web” (aka Web 2.0). With information being shared and promoted across many different areas, both geographical and social, the structure and usage of that information needs to be careful considered, and with more and more information sources moving from traditional outputs (print) to modern outputs (web), then the modern day technical communicator has, essentially, become what is now known as an Information Architect.

Strictly speaking it’s more another ‘hat’ for a Technical Communicator to wear but the idea is the same. As well as writing, design, illustrating, and doing everything else that is involved with creating technical documentation, now may need to consider an additional mode of usage, one which has grown rapidly in the past couple of years.

The more I learn about Information Architecture, the more parallels I find. Designing information structures, leveraging an ever increasing set of tools, is fast becoming part and parcel of our jobs (well, ok, MY job at least). Add in the fact that we are, frequently, the people populating those structures then it’s easy to see that there are many lessons we can learn from those in IA.

Related Information: