I mentioned in my previous post that we run a webhelp build of our content (a.k.a. our Knowledge Centre) on our developer community website, and that it was hosted in an iframe. I thought it worthwhile fleshing out the detail of that as it includes a bit of custom code some others might find useful.

As our content is locked behind a login, we need to be sure that only people who are logged in can access it. This is achieved by a couple of simple checks.

1. When the Knowledge Centre is loaded, a script runs that checks it has been loaded within the correct iFrame within our website. If it’s not, the user is redirected to the login page.

The javascript for this is added to the webhelp.js file (around line 106):

//———– init function ————
Kbase.init = function() {

//OUR redirect
if(window.top.location==window.location) {
window.top.location = ‘URLTOYOURIFRAME’;
}

2. If the Knowledge Centre has been loaded in the correct iFrame (in other words the above javascript is happy), the website checks for a cookie (checking for login) and then either loads the Knowledge Centre, or, again, redirects the user to the login page. The javascript for this is standard cookie checking stuff (google will find you a zillion solutions).

And that’s it. Nothing particularly clever, but a useful way to (lightly) protect the content of our Knowledge Centre.

Finding the right solution for a problem isn’t always easy but sometimes, if you are very lucky, the solution will fall straight into your lap. Such was the case with our switch to Author-it even though we didn’t fully realise it at the time.

I’ve covered our reasons for switching from FrameMaker to Author-it elsewhere, and once we had converted our content we started to look at how we could get the most from the other output formats available. We already had ideas on how we could use the provided HTML based publishing formats to provide a better solution to the problem of finding information, and we were planning on generate HTML versions of the entire documentation set to be hosted, and searchable, on our community website.

It was right about then that Author-it announced their new ‘Webhelp’ format which would include a (very) quick search in a nice modern looking format. Given that one issue we were addressing was how hard it is to search across multiple PDFs (which presumes the poor reader knows which PDF they should start with) it looked like an excellent solution.

And it is.

We now host a specific build of all of our content within our developer community (which is password protected I’m afraid so you’ll just have to trust me), which allows the developers, partners and customers, to search across everything we have. However we have had to customise the output a little to meet our needs, and this is where the hacking starts.

|Read the Rest of the Entry…

Time flies, particularly when a deadline looms and so it was last night when, due to this silly, short, month (which has flown by) I had to rattle out my monthly column to go in the ISTC Newsletter, InfoPlus+, toute de suite.

I mentioned this on Twitter and was promptly asked where it was published. I’ve mentioned the newsletter in passing here but realise that I’ve covered it in any more detail.

First things first, you don’t have to be a member to receive the newsletter, anyone can sign up and anyone can view the archives.

Having checked back I actually started my contributions to the newsletter in April 2008, almost two years ago, which took me by surprise. Since then I’ve been monitoring a large number of related blogs, and offering my take on the best posts from that month. I actually started doing that here but the newsletter took the focus.

The newsletter is fun, and offers me a chance to look back at some posts I’ve read but perhaps not fully digested properly and it feels good to be spreading the word about the great content that is available. There are a lot of smart people out there, and it’s good to get a chance to direct some traffic their way.

When was the last time you looked at the things you don’t do?

The reason I ask is that this very question is occupying my mind at the moment as I try to pull together both a content audit of what we have and a plan to create the things we don’t have. Which isn’t as easy as it may sound.

There are three or four different departments involved in the audit, and from each I’ve asked the same two things:

1. A list of all the content you currently have
2. A list of all the content you would like to have

With both lists in place, and understanding that some items in the first list may also need some rework or ongoing maintenance, we should all have a good view of what everyone else is doing and be able to plan a smarter way to produce more of the items in list two.

Whilst this is nothing radical it should help us by making people step back to see the big picture and allow us to move forward in one direction. Once this phase of the content audit is complete, the next stage, planning how to fill some of the “would like to have” gaps, will begin and once we start producing this content, regular catchups will help keep everyone up-to-speed and make sure we all focussed towards the same goals.

The tricky bit will be populating the second list. Asking your audience or colleagues for input will lead to one thing, a very big long list of “hey, do you know what would be REALLY good…” style requests. I’m more than happy to field those and they are, for the most part, good to have noted down.

Where it starts to get tricky is in the prioritisation of these things, and for that you’ll need to get some of the interested parties together to help. I’ve already covered how I do that but to make that process a bit slicker (it’s very ad-hoc at the moment) I’ll be setting up a common “Information Planning” meeting. That way we can involve the pertinent stakeholders in the decision process, and it will help communicate the ongoing plans around the Information Strategy.

Towards the end of last year I started to see how several related, but disparate, strands of work would start to come together. The information produced by my team, the training collateral, the partner focussed material, is all focussed on the product and this coming week will see the first step towards the realisation of all that hard work coming together into a cohesive story.

The final push comes in the form of a content audit, which will allow me to see where the gaps are, and where rework is required, to complete all the ’stories’ that run from the main product messaging, down through our information strategy pyramid.

At present we have successfully moved to a single source/content re-use system which allows us to publish content to a knowledge centre hosted on our developer community website, that content is also used by the sales/pre-sales department who receive it in a different format.

The developer community website will be used by partners to both learn and keep up to date with product developments, and reduce the burden on our Support team (something that is already happening with call numbers going down since we introduced our new knowledge centre). The website also means we can look at producing our forms of content for information delivery, videos, screencams, example tutorials and such like.

This is an area where the training team and publications team will come together and which the content audit will help drive.

On a personal note it’s nice to be on the final straight of some ideas I’ve had brewing for a couple of years now. I’ve been lucky that I work with a team of guys who I trust completely to do a good job and who’ve never let me down regardless of the challenge.

It’s going to be an exciting few months, with much to learn and many hurdles to be overcome but once complete I think we will have an excellent, information focussed culture throughout the company.

Buy-in for the information strategy will be re-enforced by the content audit as I’ll need to talk to everyone who could/should be involved, but it is noticeable that there has been a shift in understanding throughout our company with the realisation that information will play a larger and larger role in driving us forward.

I think I’m starting to get it. I’ve used it a couple of times but not for any other reason than to play with it, but now I have an actual need for a place to collaborate with a group of geographically displaced people, the ISTC Community website, it’s starting to make sense.

And I’m not the only person that thinks Google Wave is best suited to this kind of collaboration.

I’ve realised that what Google have done is take the best bits from a couple of different communication channels, combine them and add a couple of improvements.

Those channels are email and Wiki, with a hint of instant messaging thrown in for good measure.

The easiest comparison is to email, with threaded conversations the main thrust of a Wave, but as you can edit and ‘interrupt’ any part of an existing message, with that edit viewable to everyone else on the wave, soon you begin to realise that it’s more like a message based Wiki.

The ability to see new messages in real-time adds in a type of instant messaging but I think the value stands in the staggered, traceable, timelined edits of messages. For a collaborative, group project workspace this is wonderful.

I’m still learning Google Wave and as it’s still being developed there are a few quirks and annoyances to be overcome but despite those, so far, they are far outweighed by the benefits.

There are other use cases of Google Wave in action, and if you are interested, I do have a small number of invites left.

As has been mentioned elsewhere, I’m currently planning to build a community website for the ISTC and thought it time to get you all a heads up and ask for some help.

The idea for the website was borne from the members panel that Rachel Potts ran last year, which cited “reducing the feeling of isolation” as an important benefit of being a member of the ISTC. It will also help to promote and publicise the ISTC and hopefully become a valued resource for technical communicators in the UK.

As such the new website will compliment the current ISTC website, and has two main aims:
– to encourage a sense of community amongst members, enabling all members to contribute and discuss related topics
– become the ‘online home’ for technical communicators in the UK

Initial thoughts and ideas include:
– sections for the local area groups
– a directory of ISTC member blogs (and other blogs of note)
– online forums
– regular updates (ISTC news or articles of interest)

The sky is the limit to be honest, but to better refine the list of requirements, and come up with a set of features I’m looking for some volunteers. I’m looking for your ideas and suggestions.

This website is for everyone to use, and it’s up to us to decide what features it will and won’t have, so please get in touch if you are interested.