I, like most geeks, am always happy to learn more about space programs. Recently several friends went to Houston and the Space Center there. They met astronauts and did other things I’m deeply envious about.

One of my friends took pictures of the documentation for the space shuttles that I thought I’d share. Click here to see the pictures.

Why do we care?

The shuttle people are very smart people. So the actual instructions are probably written at a high level of knowledge because you can trust these smart people to know a lot.

But what I found interesting was, as my friend wrote,

the formatting and layout of these. The books are printed in a large, san-serif font on card stock. The binding is open rings, so they’ll lay flat without any argument. Remember that 95% of the time, these are going to be in zero-G, so any slight tendency of a book to snap shut (from a perfect binding that would normally be fighting against gravity) would cause the book to close.

The page layout is very loose and open, and could be written on with a pencil easily. The blue tape is velcro (NASA just lives for velcro!). As you can see in some of the later pix inside the shuttle simulator, the books are velcroed in place everywhere so they can be seen easily.

Audience is everything, except when environment is everything

So, not only do we need to think about what information  our users need, we also need to think about how and when they will be using this information. Most of us are not designing information to be used in space, but what an interesting problem to solve. And what an ugly but perfect solution they found. (You have to admit, the blue velcro is ugly but very visible.)

Talk about tailoring the information delivery to the needs of the audience!

What unusual environmental information delivery problems have you solved?

WritersUA in Long Beach last week was fun. We met a lot of people in the booth and at the show in general. I got to see our product demo-ed by a fellow who has been showing our products for years and that was a huge learning experience for me. He’s very good.

Author-it Morning was a blast. We had more people than we thought attending and everyone was excited and interested. For half the morning, we threw out our stated agenda and did what the audience wanted to see. One attendee said the morning made the entire show worth her while. Good stuff.

Peer showcases

One of the things I really like about WritersUA is the Peer Showcase event. It’s usually the last day in the food and drink area, making it available to everyone. Selected people get to show something interesting they’re doing and answer questions about it. I sat in a demo by a lovely woman who is creating, on average, 1 user guide a day using Author-it. The way she has everything set up so that she swaps out what needs to swap out and then clicks Publish had me amazed.

She uses Release States for product lines. So, for example, content that is common to all manuals are set to one release state with a color. Content that is specific to each product line is set to other release states and colored differently. That lets her see at a glance what belongs to what. I would never have thought of that and it’s a perfect solution to the problems in her workflow.

Brilliant. Just brilliant.

While I watched her talk about how she did what she did, I realized that Author-it lets the 2 writers do the work of 4 writers. Talk about doing more with less! The ROI for this group of writers was measured in days, I think. And, she said, the rock solid publishing profiles meant that she always got what she expected in the output, saving hours a week in production review.

People swarmed around her table, amazed by the workload and the solution.

Local sightings

I’ll be at the Silicon Valley STC chapter March 24 for a preview of Author-it and other fun stuff, if you’re in the area. I’d love to see you there!

Not a lot of blogging this week, as we’re at WritersUA in Long Beach.

Sunday, we did the Author-it Morning and had a great time. People got a lot of value out of the 4 or so hours we were together and it was fun.

Today, the booth is very busy and the show attendees are full of excitement.

Watch Twitter for the #writersua keyword to find out what’s going on.

And if you’re at the show, stop by the booth and see what the buzz is all about.

If you’re working in a typical document-centric content development environment, you probably manage versions of product documents by copying the entire previous document(s), renaming to the next version and go from there. While this seems like a good way to manage versions, problems can arise, including how to find and manage all the copies floating around your source control or internal network.

And if you need to compare what content applies to what version, life gets really complicated. You can use the built-in document compare but for some products, variables and cross references count as changed text, not really giving you the picture you need.

You could always print out the compared document and do a line by line manual highlight of the actual changes. Unless the document is more than about 100 pages because who has time to do that for the 30 documents you produced 3 versions ago? And then you’re stuck with paper trails you need to manage. It’s a very cumbersome process.

There has to be a better way

A better way would to be able to assign a version to the content when you create it. That would at least show you somehow that this topic was added for version 3.1 and that content appeared in version 4. You would have some sort of audit trail to see what appeared or changed and when.

Building the output could get complicated, though. If you want just the content that applies to version 4, you would have to somehow include the content that didn’t change since version 2. But you don’t want the version 3.1 content, just the content for version 4 and the content that hasn’t changed since version 2.

You would have to mark content as valid for version 2 and 3 and 4 and 4.1 and… That sounds cumbersome, too.

Maybe an even better way

An even better way would be if you could somehow specify you want version 4 and the publishing system programatically looked for all version 4 content and gathered that up. For content that isn’t marked version 4, but appears in the list of content you want to publish, maybe the system could walk back versions to find content.

That way, the system tracks things down and you don’t have to manually assign multiple versions to the content, which you’re going to forget to do.

Computers are really good at tracking things. Why don’t we let them do that part and we can create the content?

It’s a better way

Environments that are regulated, such as financial or medical, should like this approach. This even better way of versioning let’s you easily create the documents as they were for each point in time so the auditors can easily see what they need.

Environments where your technology has a long life span might also like this versioning method. For example, if your technology is still in the field and still working 20 years later, you may need to create documents for it on request, even though that version is 20 years old. With this even better way of managing versions, it’s not a problem – simply specify the version to start with and the system does the rest.

Sound interesting?

By Sharon Burton

Some days, your technology works for you and some days I think it’s out to get us. Today has been a bad technology day for me. I’m hoping it gets better as the day goes on.

Managing stress

When I’m stressed, I’m learning to go for a walk to help me manage myself. Just because I’m stressed doesn’t mean the world is actually coming to an end. I’m finally learning that walking a mile helps a lot. Especially if the day is pretty and the sky is blue – it’s hard to remember what I was stressed about when I get back.

I also find I’m more productive if I get up from my desk and walk a fast mile. When I come back, my mind is usually clearer and I feel refreshed. I can get a new outlook on something that gives me a breakthrough.

The content authoring/publishing world

Our field can be very stressful. We are a deadline-driven industry with lots of things clamoring for our attention.

Long gone are the days with one project and one thing to do all day long. Most of us have too much work for the time available and somehow we make it all happen. People show up in our offices with surprise projects that must be done right now!

But what does all this do to your stress levels?

Long term stress is bad for you

Study after study shows it’s not good for the body to be constantly flooded with stress chemicals. Additionally, it’s really not good to manage stress by over-eating or over-drinking. Nothing happy comes from either choice.

So, this year, finally, I’m learning to walk off my stress. On the weekends, I walk one of my large dogs at least 2.5 miles every day, which is great for both of us. But I’m not limiting myself to weekend walking. If I need to get out of the office for 20 minutes, I walk a mile.

What are you doing to keep your stress levels managed? How do you relax and redirect your mind?

WritersUA

One way to recharge your mind and body is to attend a conference. It’s good to get out of the office and into a creative group as passionate about our field as you are.

Remember, the WritersUA conference is March 13 to March 16. Additionally, Author-it is holding an Author-It Morning half day event Sunday, March 12 from 9am to noon at the conference location.

Sign up by sending me an email to sharon[dot]burton[at]author-it[dot]com with Author-it Morning in the subject line.

We’ll see you there!

By Sharon Burton

After a webinar the other day, I would up chatting in email with a fellow about useful books. So I thought I’d post a list of books I think should be on your bookshelf.

Listed in no particular order:

• Illustrating Computer Documentation: The Art of Presenting Information Graphically on Paper and Online by William Horton

Altho this book was published in 1991, it’s still very relevent today. He covers how to present information visually, especially important for us non-visual learners.

• DITA 101, 2nd edition. by Ann Rockley

Even if you’re not moving to DITA, this book is valuable because it makes you think about how to structure your information to be useful to your readers.

• Information Development: Managing Your Documentation Projects, Portfolio, and People by Joann T. Hackos

I cannot recommend this book enough. She clearly discusses why content is a business asset and how to manage it.

• Single Sourcing: Building Modular Documentation by Kurt Ament

Do you have any to add to the list? What have I missed?

Since the awful earthquake in New Zealand this week, clients and non-clients all over the world have contacted us, concerned about our staff. This outpouring has moved everyone at Author-it and we’d like to thank all of you.

The Auckland office and all our people in that office are OK. The earthquake was about 400 miles away. All family in the Christchurch area have been accounted for.

Remember, if you want to help the people in Christchurch, contributing to the New Zealand Red Cross is a great way to help.

On a related note

Have you looked at your policies and procedures lately? When a disaster like this happens, it should remind us that we need effective policies and procedures in place. Everyone needs to be trained in what to do.

Make sure yours includes:

• Evacuation plans
• Disaster recovery plans
• Reporting-in plans
• and more

Disasters usually happen suddenly. It’s important for everyone to know what they should do and how to keep the business running (or not) during the disaster.

People at least need to know how to get out of the building and where to meet. If the disaster happens at lunch, do you have a plan in place for people to report in so the missing can be quickly accounted for? Do several people have the cell phone numbers for everyone? Where are those number stored? How is the data in your company being managed for offsite backups? Do you even do offsite backups?

These and more need to be clearly defined so everyone knows what to do. Now might be a very good time to make sure your policies and procedures are up-to-date and people are trained.

Fascinating day. Lots of interesting people came to the booth to talk about the content issues they have and how we can help.

I love meeting people and talking about the common issyes we all face developing, managing, and publishing content. Really, it doesn’t matter what industry we’re in, we face similar issues.

New thought for Tech Comm

A thought that occurred to me about the Technical Communication field. We need to stop thinking about our user assistance content as special and silo-ed. It’s not helping us anymore. We need to start thinking about our content as just more content the organization is trying to manage.

Content is a business asset, just like another other thing the company owns that adds value to the company.

Impact

So if the user assistance is just part of the overall content the company needs to develop, manage, and publish, where does that put us? How do we integrate into the larger corporate picture?

What do you think?

By Sharon Burton

The weather here in Palm Springs is lovely. Warm sunshine to sit in a drink coffee. Which I did this morning.

The booth is almost set up – I’m missing 2 boxes and am tracking those down. Since it’s all my marketing materials, it’s sort of important!

I’ve already run into people I know who are here for the pre-conference workshops. Hugs all the way.

The Intelligent Content conference looks to be great!

I’m working on a series of white papers for a project we’re doing. Since we internally use Author-it for our documents, I’m spending a lot of time in Author-it, creating my white papers.

These are a few of my favorite things

One of the things I really appreciate is the content reuse features. Because I’m sometimes writing about the same thing for different audiences, it’s really nice to so easily drag-and-drop existing content into either my book, if I want an entire existing topic, or create a small piece of content if I need something smaller. Drag it in place and I’m done.

I’m also appreciating variants. Sometimes we have an existing topic that’s not quite what I need. I create a variant of that topic and then change it for my particular book. Perhaps I make the voice more friendly or change the language to a different audience. When I build my output, I specify which variant I want to use and I’m done.

If you want to see this stuff and more

Don’t forget next week Paul Trotter and I will be at the Intelligent Content Conference in Palm Springs. You can meet with us, see ways to solve your content issues and generally just chat.

Paul knows everything there is to know about our products, plus he’s super smart in our field. I’m certainly going to pick his brain for the few days! You should join me.

By Sharon Burton