Category: Work

Mostly an archive of my posts from onemanwrites.co.uk – a blog I used to write when I worked in the Tech Comms industry

One step forward…

Firstly I’ll admit that I’m starting to feel a bit like a fool. I’ve been close to getting the new ISTC website launched for several weeks now, only for an subtle twist or unforeseen working process to scupper my plans.

I realise now, of course, that what I should’ve done was revisit the usage models of the website and finessed those first, rather than trying to shoehorn a somewhat antiquated set of processes into what is a fairly standard membership model. Oh well, live and learn.

That said, it’s not been the legacy processes that have really slowed me down, “life” hasn’t been particularly helpful either although quite how I’m sitting here in January when I’d hoped to have the new website launched in September last year is beyond me. My sincerest apologies, and please trust that I’m hugely annoyed by these delays.

The main reason for the delay has been making sure the membership functionality work, making sure that the processes for applying for membership, as well as renewing existing memberships, has been tricky, as has considering non-member access. The latter is something that only came to light at TCUK (in Sept) this year, Area Groups are not attended only by ISTC members so the website needs to be mindful of that as it will have, in the future, specific areas for Area Group attendees.

As such, there are essentially five levels of users for the new website:

  • Administrators – essentially myself (webmaster) and the team at ASL
  • Editors – anyone with the ability to post new content to the website
  • Members – access to content for ISTC members only
  • Attendees – for those who attend Area Groups but aren’t ISTC members
  • Guests – anyone visiting the website that isn’t logged in, or isn’t a member

It’s a more complex setup but in the long run it will make the new website much more flexible. A lot of the ground work I’m doing at the moment is in the background, with the hope that, this year, new features will be much easier and quicker to roll out.

And, just to prove that the new website does actually exist, here’s sneak peek of what will be launching soon: http://46.183.9.143/

Thanks for all your patience.

Ho ho … ho?

It’s true.

I’ve checked the calendar.

Twice.

It is definitely almost Christmas.

Which means it’s almost the end of the year.

How did that happen?

I’m a bit disappointed that I’ve not yet managed to get the new ISTC website up and running. It’s close, so close, and after a few frustrating weeks of backtracking and replanning part of the implementation (the member database part, quite important that bit!) I now have a clear path forward and will be looking to get it tested (I have volunteers already, more welcomed!) in the next few weeks.

Mind you, the past six months have been hectic but well worth it. We’ve grown our team and have a strong plan of action for the coming year, the challenge will be getting it all done.

So, next year is looking like it will be a good one.

Mind you, still need to get past the next couple of weeks.

On not blogging

A product release is imminent.

A trip to visit two customers in the US of A.

Ongoing complications with the new ISTC website (soon, soon!).

Planning for 2012, including a major restructure of our content.

Actual writing some documentation (a rare occurrence!).

Plus all the usual things that life is wont to throw at us.

Maybe look for me on Twitter instead?

ISTC Area Group meeting – West of Scotland

Thursday 13th October, from 7.30pm, in Waxy O’Connors pub.

The next ISTC technical communicators’ meeting in Glasgow will take place on Thursday 13th October 2011, from 7.30 pm onwards. I will be presenting a report from the Technical Communication UK 2011 conference. Come along to talk about latest news and trends in communication, or just to meet other communication professionals.

The event is free and open to anyone interested in technical communication, such as technical authors, information architects, internal communication professionals, report writers, marketing writers, web content writers and graphic designers.

Venue: Waxy O’Connors pub, 44 West George Street, Glasgow, G2 1DH. Please make your way to McTurk’s Room on the middle level.

TCUK11

I went to a conference and it was good!

As ever the Technical Communications Conference sparked thought, debate and no little amount of revelation. The sessions I managed to attend were all well presented, well considered and well received, and the chats over lunch, dinner and at the bar prove to me that I’m in a profession full of driven, smart and engaged people. My impression of the attendees this year suggests there is a definite change in the attitude of the audience as well, a little more upbeat and vocal, all of which bodes well for Technical Communications in 2012.

As ever, I took sporadic, and somewhat random notes, and I’m happy to share them with you all… YMMV as to whether you understand them or not.

Tuesday 20/09/11

Workshop: Using the Tech Author Slide Rule by Alice Jane Emanuel

Should we enter our documentation into industry competitions? Probably worth it purely from a feedback point of view.

Scoring spreadsheet used in the workshop will be useful in a number of ways as it will:
– show areas of specific improvement in the product documentation
– provide numerical data to show we are improving the quality of the information
– help everyone understand what is required to provide good quality information (particularly new starts in the team)
– reporting on the numbers will raise awareness of what we do (targetting an ‘area’ will alert people we consider this important)
– drive internal team discussions on how we improve quality (some of the scoring will be subjective, so will need discussion to get agreement), have whoever scored an area present back their thoughts

Wednesday 21/09/11

Opening Keynote: Patrick Hoffman (Google)

Icon Designer for Google Maps, Patrick discussed visual design, how the smallest details make a difference, the part context plays in cognitive understanding of graphics, as well as the impact of culture/location on that understanding.

Good icons present a single core message (remove the adjectives from the graphics?)

Content Strategy from the Trenches by CJ Walker & Karen Mardahl

Interesting presentation concept with CJ interviewing Karen, fireside chat style.

Content Filtering becomes a strategy, our ‘articles’ are just a filtered view on to the bulk of the content
Analytics data – what are we using it for?
Change team ethos to focus on value add, adding info to docs is how we add to the value of the product

Writing for reuse by David Farbey

Define your goals for re-use – what influences the process? Know where the goals may fail and plan around them.
Taxonomy – spreadsheet for areas of re-use (categories of information we expect to re-use)
Metadata needed – consistent naming a must
Information Types – we already have these, do they meet our needs? Do we need to review them?
The less you want to write, the more you have to plan

Forget about the book!

Concept topics – learning something (About the….)
Task topics – doing something (Configuring… )
Reference topics – knowing something (Lists/Facts/Tables)

Other topic types, what are they for?

Thursday 22/09/11

Pattern Recognition by Kai Weber and Chris Atherton

“To understand a pattern you need examples”

Code examples – must be consistent to let reader derive the pattern to understand the rules
Little used patterns degrade over time. People forget.

Difference between how learn

Experienced users: Top Down – Uses prior knowledge, concepts > elements, emphasises context, quick; sometimes wrong (knowing, generalising, contextualising, applying).
New Users: Bottom Up – No prior knowledge, elements > concepts, emphasises relations, slow; usually correct (experiencing, acquiring, matching, segmenting).

? What patterns should we have? What patterns do we have already?
TOC can be a pattern – consist info titles, build the pattern, e.g. “How to” always displays topics that look a certain way and contain certain information.

Opportunities for reuse between documentation and training by Linda Urban

Reuse definition – for docs – single sourcing, topic level, granular (para) re-use

Re-use is hard due to context:
Training is about learning, building skills
Documentation is about “I’m working”, help me, quick answers

Training is about approach and doesn’t (shouldn’t) cover everything

Documentation is an external repository of information
Training creates an internal repository of patterns/information

In practice, re-use sometimes means repurpose

Re-use sweetspots: integration points

Bigger picture: need to plan the information in tandem, docs should compliment the training and vice versa

And finally…

I have to mention the entertainment provide as part of the Gala Dinner. A genius of word play and smithery, Judge The Poet was brilliant and perfect for the conference audience! You can see some of his work here.

As well taking notes during the sessions I attended, I also took some time to showcase what will be come the new ISTC website (sneak peek here), and hosted the Rants session which a lot of, noisy, fun! Alice Jane Emanuel kindly took notes and I’ll be getting them published in next months InfoPlus newsletter.

Next West of Scotland Area Group meeting

The next ISTC technical communicators’ meeting in Glasgow will take place on Thursday 13th October 2011, from 7.30 pm onwards.

As it’s happening just after the conference, I will be presenting a (short) report from the Technical Communication UK 2011 conference. Come along to talk about latest news and trends in communication, or just to meet other communication professionals.

The event is free and open to anyone interested in technical communication, such as technical authors, information architects, internal communication professionals, report writers, marketing writers, web content writers and graphic designers.

Venue: Waxy O’Connors pub, 44 West George Street, Glasgow, G2 1DH. Please make your way to McTurk’s Room on the middle level.