Regardless of what you exactly do in the field of creating or producing information, you spend time developing content. For most of us, that means writing but some of you do screen videos, or make illustrations.

I’ve come to realize in the last 2 or so years, we need to stop calling this writing, or drawing, or what ever and refer to this process as “developing content”.  And I have some good reasons.

Developing content

There is the thought out in the business world that “anyone can write – we were all taught in school how to do it.” And that’s a silly idea. In school, we were given the tools and shown how to use them.

• We got a hammer and learned to pound on things.
• We got a screwdriver and learned to turn things.
• We got a wrench and learned how to wrench things.

But very few of us left school knowing how to build things. So why does the business world think we all did? For some reason, the business world thinks that all you needed was an introduction to the tools and you’ve got the skill.

They don’t think that about managing their financial books. We all can basically manage a household budget but probably none of us are suited to be a CFO.

Writing is a skill and a gift

Most of us professional writers started with a gift and spent a long time learning our craft. We improve and improve to the end of our lives.

Much like a carpenter (to continue my metaphor) who starts with a gift and learns more and more over the course of his or her life. The work of a master craftsperson is breath-taking in its beauty.

So, if the business world thinks that what we do is essentially unskilled apprentice labor and that anyone can do it, we need to reframe the discussion.

Developers make stuff

My reasoning for content development is that developers make stuff. Perhaps in your company, they develop code.

We make stuff, too. And our stuff is as important and needed as the code is. After all, if you can’t use the product, what good is it?

Therefore, we’re content developers. We develop content, regardless of writing, illustrating, or anything else we’re creating to support people in what they are doing.

Try it out

Try it out in your workplace. Start quietly calling what you do “developing content”. Don’t make a company announcement or anything. Just start using the phrase. I bet in 6 months, it’ll come back to you from someone else.

Do you agree there is value or do you think this is silly semantics?

As I’ve stated before, I’m not a strong visual learner. I like words and getting my hands on things. But many people are strong visual learners and I need to accomodate them in any content I develop. So, since I like words, I found a book that helps me with visual information. I thought I’d share some highlights with you in case you’re also not a strong visual learner.

By the way, to find out your learning strengths, take the VARK quiz.

The book is a classic: William Horton’s Illustrating Computer Documentation. Wiley Press, 1991. I realize it’s older but the concepts and principles are valid regardless of when it was written. If it’s not on your shelf, I strongly recommend you get it. Mine is dog eared and written in and tagged all over.

Design content for scanning

Since I like words so much, I was delighted to discover that words can be graphical elements, too. Lists and tables are visual and need to be designed as such to support your visual learners.

While tables are inherently a grid, you can make tables harder to read by using horizontal AND vertical lines. Pick one (and you may not even need that) that suits the information and stay with that. Make any lines thin enough to let the eye follow but not thick enough to visually draw the eye.

Since humans are hard wired (because of the rods and cones in our eyes) to see lines, we want the thickness of the line to not overwhelm the visual field.

Lists are always a good thing to use. If you use lists, make sure they are used correctly.

1. Numbered lists imply steps.

• Bulleted lists imply a lack of order.

• Check box (which I can’t figure out how to show you here) lists imply completeness.
  • If you use several levels of lists, use a different bullet for the other levels

Organizing content visually

Screen captures are good and we all use them, assuming you’re developing content for software. But think about how else you can visually show information.

For example, the last time I was documentation manager, I instituted a policy that every chapter (section) must have an introductory paragraph(s) and then a graphic that illustrated the ideas in the paragraph(s). This supported both our word learners and our visual learners. It visually organized the content in that section.

Typically, we had a flowchart, showing information flow through the system but sometimes we showed how parts worked together. It depended on the content in that section. We single-sourced that graphic to the online help to support the different learners there as well. Had we the time and the staff, the graphics might have become animations online.

On a different note

Don’t forget to go to Facebook and Like the Author-it page. At the STC Summit, we’re doing a special drawing from the list of Facebook Likes and giving away something very Kiwi. You want to be in that drawing, even if you’re not at the STC Summit.

There’s a lot going on at Author-it in the near future. We have webinars and are attending conferences. These events provide you an opportunity to learn, ask questions, and meet people.

Product webinars

We have several webinars coming up, some product-specific and some tools-independant.

If you’d like to see what’s coming in Author-it 5.5, we have several webinars available for you over the next several weeks. We also have a webinar in May about importing your legacy content into Author-it.

To sign up for any of these webinars, click here. Remember, we record these webinars and make them available the day after so if the scheduled date or time don’t work for you, sign up anyway and you’ll automatically get a link to the recording the next day.

General webinars

We’re also hosting several tools-independant webinars. If you want to learn more about Component Content Management, we’re offering a webinar on that topic April 28th, 1pm Pacific, 4pm Eastern.

Paul Trotter is sharing his vision for content development April 25 at 1pm Pacific, 4pm Eastern. This is also a good webinar if you’re boss doesn’t quite understand what content development is about and why it’s important in this century.

And May 11 at 1pm Pac, 4pm Eastern, we have the Content Trends Survey Results webinar where we look at the data from the survey and what it means to content development professionals.

To sign up for these webinars, click here. We also record these, so again, sign up even if the time and date don’t work for you to automatically get the recording the next day.

Conferences

Author-it is attending the STC Summit May15-18 in Sacramento CA. We’ll have a booth and several of our staff will be there (including me), ready to meet you and talk about how our products can help your organization. Additionally, Kirsty Taylor is presenting tips and tricks in Author-it Localization Manager at the Summit. This is a good way to see how a real user works in Localization Manager.

If you’re not at the STC Summit in Sacramento, then maybe you’ll be at the STC India Summit May 7-8 in Bangalore, India. This exciting event includes Saurabh Kudesia talking about Planning, Managing and Implementing Content Variations using Author-it.

We’ll see you soon!

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!

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

Paul, our fearless leader, and I are at the Intelligent Content Conference in Palm Springs this week.

I’m driving to Palm Springs, since I live about 60 miles away. It’s one of my favorite drives, as the freeway is wide and generally open most of the way.

I plan on micro-blogging anything interesting so watch this space for more as the week goes on.

If you want to see us or just chat, stop by our space and do so. Paul can talk your ear off about the most interesting topics!

The new issue of the journal Technical Communication is out and there’s an article that I found very interesting.

Single Sourcing and Content Management: A Survey of STC members. David Dayton and Keith Hopper.

I’m not going to do a detailed review because you all can read it yourself. But what I found interesting was some of the results.

Results

Of the 276 respondants to the survey, half reported using single sourcing or single sourcing with some sort of content management. I would have expected that number to be higher, since single sourcing has been around since at least 1996. The cost (time) savings alone make the content development method make sense. It’s just not a new technology and I was surprised that not 90% or more are single sourcing.

Drivers of moving to a single source and/or content management development method were unsurprising:

• faster information development
• regulatory or compliance issues
• translation efforts

About half the people using single source and/or content management said there are downsides and tradeoffs, which I found completely unsurprising.

These information development techniques are potentially restricting if you want to just focus on writing. These methods force you to think about how and where your content is going to be used and that can feel restricting. But it’s critical, I think, to consider when you develop information.

A surprise

Apparently, the majority of people are using Word to author and are trying to do some sort of single source and/or content management. Which I think is doomed to failure.

Word is a delightful tool for short documents. But if you’ve written a 400 page book in Word (as I have, several times), you know it’s the wrong tool to try anything like single source and/or content management. They don’t give us numbers for the failed projects that were done in Word, but I’d like to see those.

They do seem to find that more larger companies have moved to single source and/or content management as compared to smaller companies. I have to wonder if larger companies see the business benefits of managing their information the way they do any business asset. Smaller companies may not have reached that point yet.

I’d also like to know how many small companies are using Word, as opposed to the larger companies. Again, smaller companies might be using Word because they are not thinking of information as an asset to be managed.

The summation

The summation was interesting to me – the authors say that a single source and/or content management environment has hit critical mass. This information development method is now into the early majority.

But if you look at just those using a content management system (which should include single sourcing but the authors say it doesn’t have to), then this development method has not quite crossed the chasm.

There are a lot of other pieces of good info and you should look up the entire article. It’s worth it.

What are your thoughts?

Hello, I’m Kendra Carter, an Author-it consultant and trainer here at Author-it Software Corporation. I’ve been an Author-it user for the past nine years now, and I have to say, I am so proud to see how the product continues to grow and expand its content reuse and single sourcing strategies. With the release of 5.2 and structured authoring, clearly Author-it continues to keep up with what’s next in the content management industry.
Speaking of keeping up, how are your Author-it skills? Would you like to learn more about using Author-it . . . for free?!
Attend a free Author-it training at DocTrain West! We’re offering a one-day Author-it basic training post-conference, Friday, March 20, 2009 from 8:30-5:00. This two-part training begins with basic authoring techniques and single-source strategies that make Author-it the leading product for content reuse; it concludes with training on our new, highly anticipated structured authoring option. We’ll talk about best practices for implementing structured authoring on Author-it content. We’ll first put our designer hat on and look at implementing structured templates using the new Author-it Structure Builder. We’ll discuss how to write rules and how to give authors helpful examples and tips on following the rules. Then, we’ll put our author hat on and learn how to create content based on structure rules and what steps to take to verify that content “validates” against these rules. Existing Author-it users—in case you’re wondering, you can impose structure on previously structured content! We’ll talk about how you can implement structured authoring on existing content and helpful tips for doing so.
This training would also be helpful for any existing v4 customers who are wondering whether they should upgrade to Autohr-it 5. You’ll get to see the new interface and it’s many features.
I promise you won’t need to know much about using Author-it before training. Just sit back and watch as I explain and demo basic Author-it functionality. Take the complimentary student materials and exercises home with you to try on your own time. And, feel free to ask any product-related questions as we go.
So, join me for our DocTrain West post-conference training. Be sure to bring your laptop if you would like to follow along. Here’s some more information on the session.
Hope to see you there!
Posted by Kendra Carter, Author-it Senior Consultant, Author-it Software Corporation, kcarter@author-it.com