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?

I’ve been training customers the last few weeks and so not as able to keep up on the blog as I would like. But, being in Author-it every day, showing various ways to make your workflow easier made me think a post with some of that might be interesting.

Feel free to add your own favorite things in the comments.

Variants in 5.5

We’ve had variants for some time. But the “fall back” feature is one I like a lot. Here’s how it works.

In Author-it Adminstrator, you need to either create a new variant or modify an existing one, depending of what you need to do. We’re going to look at an existing one – it’s called Version. Click the picture and then click it again to see it large.

The important thing here is the Browse button next to the Value list.

By clicking the Add button, I added various versions of the product to my library. I organized them in a hierarchy by using the green arrows in the upper left of the dialog box.

So, what does all this mean? It means that as I create new content I can assign a variant to the content. So, for example, I have an overview of the product. I wrote it for V2, but it  hasn’t changed in any of the versions since then.

But as I add content for the different version over time, I can assign different variant values to that content. Perhaps we did a bug fix/special version for a company and called it V2.1a.  For that version, we added some new content and marked it as V2.1a. All the content for V2.1 is in this book, plus the V2.1a content. But some of this content, we’ve not updated since V2.0 and don’t need to update – it’s all still accurate.

In other words, in one book, we have topics with a mix of versions assigned to them, using the variants.

So, maybe we’d like to publish the V2.1a book but we’d like to see what content goes in that version before we publish.

In Author-it Editor, we open the book. At the bottom of the list of topics in the book is the “Filter contents using variant criteria” list. If we click on that, we see a list of the available criteria and we can select one or more.

So, for example (click the picture and then click it again to see it large.):

What we see is just the content that is marked V2.1a and any content that appears in the fallback path, if there is no content marked V2.1a and any content that doesn’t have that variant criteria applied at all.

To make life even more interesting, I have another variant I call ShCountry. Because, in my example, we also now send similar but slightly different content depending on the country it’s going to. You can see that I selected Australia as the ShCountry variant and the ProductVersion as V1, You can see the topic marked with the V2 variant is lined thru. This means that topic will not appear in this output, if I select these variant criteria for publishing my book.

Because I can select to apply and select multiple variant criteria for my content, I can use one master book and then filter, based on the variants I select to meet my customer and product needs.

In conclusion

Well, I promised you several and gave you one favorite thing. The next blog post will be more favorite things. Promise.

We are in the business of getting people the information they need and letting them get back to their life. Fundamentally, that’s what we do, whether we write user manuals, policies and procedures, create illustrations, videos, or any other thing.

And in this information rich world, this is an important thing to do.

No one reads the manuals

If I had a US dollar for every time I’ve heard “No one reads the manuals” I’d be retired in the tropics, playing with large dogs and writing crazy stories. While no one reads the instructions is a true statement, it’s a false statement.

People do read the instructions we provide. They do. But not like a novel – when was the last time you read your employers Policies and Procedures guide, start to finish? Probably never. It’s not that interesting.

But you may have read a part of it in the last month – perhaps when you completed your expense report for attending the STC Summit conference. Because you couldn’t remember what the per diem was and how to charge that properly. Because you don’t fill out expense reports often, you needed to be reminded of how to properly do that task. So you could get on with your life.

And that’s how it works

This is how our instructions are used – on demand. People rarely read our instructions from beginning to end, to see how it all turns out. Typically, people read what they need to know right now and then move on.

Perhaps they need to refresh their memory about how to run the month-end report, or how to rewire the speaker wiring for the home theater system the 3 year old gleefully pulled out. or they need to create an expense report.

So how can we help?

We can create short, to the point instructions for these user moments. I call them Job Aids, you may call them something else. But they are short overview instructions for important infrequent tasks.

Installation is a good job aid – typically called Getting Started guides. For most things, you install one time and then never again. You probably don’t reinstall your garage door opener – after it’s complete, you can happily throw away those instructions.

Other tasks that make good job aids are running end of month and end of year reporting. Not done often enough to remember exactly how to do it so a refresher is helpful. You probably don’t need to include how to run a report, because reports may be run at the end of every day. How to set up the end of year report and archive the data is similar but different.

Make them available to your users

OK, so if my users only need these infrequently, how do I get that information to them, you may be asking yourself.

You can ship them with the product, if you know ahead of time what is needed. But most of us don’t have the luxury of knowing ahead of time.

If you talk to your support people, they can give you ideas. Many of the questions they get are actually Job Aid questions. So talk to your support people and see if they get the same sorts of questions.

Then develop the job aid. Try to keep it to one sheet of paper, front and back.

Now you can post the job aid in the support area of your website. Ask support to tell callers about them. If you send a marketing thing to your users every month or so, include links to the newest job aids to get people to know they are there.

Job aids can impact the company’s bottom line

Consider tracking statistics to see how often the job aids are looked at/downloaded and if those sorts of questions are being asked less often in Support. That’s how you know you’re being effective. Take those numbers to management as clear evidence the docs group is making a bottom line impact on the business.

Clearly someone is reading them, you can say. As a matter of fact, this month, X people read them. And Y people didn’t call support to ask about that topic, as compared to 6 months ago.

One of the things I love about being in the high tech industry is the learning never stops. I’ve always thought having a job where you do the exact same thing every day sounds terrifically boring. And in the high tech industry, that really doesn’t happen – every day brings something new.

Training

We’ve added training to my list of things I’m doing and I couldn’t be happier. I love teaching people. I’m so passionate about this industry and what we do. I get to now also help people by providing them the tools to learn Author-it. Then, after the training, they are going to do wonderful things with that knowledge and change the world.

And I get to be a small part of that. Wonderful.

Towards that end, we’re doing several things at Author-it, short term and longer term.

Online training is free

In case you’ve not heard, we’ve made all the materials for our Core training available in small nuggets and it’s all free. If you have 10 or so minutes, you can watch a video specifically about what you want to review and then get on with your day.

This is a Big Deal.

If you want to add to your skillset and learn Author-it, you can do that with the Learning Center and an evaluation copy of Author-it. If you want to brush up on something – perhaps your company has finally decided to do online help – you can refresh your knowledge in the Learning Center.

Did I mention it’s free?

Already popular

Based on the stats, this resource is incredibly popular already. If you’ve not been to the Learning Center, I strongly recommend you get over there and check things out.

This has been a very busy week for the technical content world.

Author-it 5.5 is released

As you know by now, we released the latest version of Author-it 5.5 to great excitement in the industry. Once again, we’ve redefined the possible in the content authoring and managing world. For more details about what this release includes, click here and then sign up for the free webinar that shows you how the Author-it Reviewer works.

June 1st at 2pm Pacific. As always, if the time or date don’t work for you, sign up anyway to get a link to the recording the next day.

This hour long webinar is a don’t-miss event. We strongly recommend inviting your boss as well. S/he’s going to want to see this. Author-it Reviewer is changing collaborative work forever.

Author-it Learning Center

If you’ve been interested in learning Author-it, we have an option you’re going to love: free, on-demand training.

The Author-it Learning Center includes videos to help you understand the basics of Author-it. You learn what objects are, how to import and author content, and how to customize your outputs.

It’s all online, ready for you to view when you’re ready to learn. Each session is under 15 minutes, making is easy to find the time to learn something new.

Even if you know Author-it, it’s a great way to refresh your skills or review something you may have forgotten. What a great way to get the information you need and move on with your day.

The STC Summit Conference

And finally, this week was the STC Summit Conference. We want to thank the many many people who came by the Author-it booth to find out how our products can make life easier.

150 people wore Author-it tee shirts for the special Apple iPad give away. We talked until we had no voice, gave out chocolate Kiwi Fish, and awarded the iPad to Andrea Wenger.

A great time was had by all, as you can see in the picture below.

We’re really excited to announce the release of Author-it 5.5! Our guys (gender-neutral term here) have put in a lot of work to make Author-it even better for you and your content development workflow.

The top 2 things I’m excited about: Author-it Reviewer, and variants with a definable “fall back” path.

In this release we tackled and solved two of the most challenging problems in technical communication – conducting content reviews, and managing versioning and branching.

Author-it Reviewer

Author-it Reviewer is an exciting new web-based product that revolutionizes your content review and approval processes. Author-it Reviewer reduces the time for a traditional review process by up to 70% and transform it into a live, collaborative and interactive environment.

Using the latest web and social media technology, multiple editors and reviewers can work simultaneously in real-time, significantly improving productivity, accuracy, and auditing.

Additionally, graphs help you see at-a-glance the state of the reviews in your projects and what needs to be followed up with.

Other new features include

• Web Help enhancements for mid-topic jumps
• Support for publishing to Microsoft Help Viewer 1.0
• Multi-select importing of translation jobs in Author-it Localization Manager
• History improvements in Author-it and Author-it Live, including adding save point comments
• Acrolinx IQ 2.0+ support
• Author-it plug-in architecture extended to support event-based plug-ins
• Author-it Live user interface available in Japanese, German, and French

To see the new improvements

You can see some of the new features if you’re at the STC conference this week.Sstop by the booth and see what’s happening.

Fast update before I get ready for the conference today.

Opening night

Last night, the STC Summit officially opened. The show floor was crazy busy and I think I met nearly everyone who is at the conference. Our booth was flooded with people!

We explained the iPad give away and handed out flyers. Today, I expect we’ll be flooded again. I can’t wait.

The iPad give away

While STC is giving away an iPad, so are we. Here’s how you get in the drawing:

1. About 11am today, come to our booth and watch the demo of the new Reviewer.
2. Get a limited edition t-shirt. We only have 150 of them – far fewer than the conference attendees.
3. Wear your shirt during the conference.
4. At some point, we’ll grab someone wearing the shirt and they win the iPad on the spot.

That’s it! That’s all you have to do.

So, we’ll see you all in the booth!

It’s that magical time of the year, when STC holds its international conference. This year the conference is in Sacramento, California, a short drive from the lovely city of San Francisco. A slightly longer drive from Southern California, where I live, but I’m driving up, nonetheless. I have family there and I’m spending a little time with them before I come home.

If you are at the STC conference and want to talk, stop by the booth. We will be doing in-booth demonstrations during the breaks, so if you want to see some new stuff, this is your chance. If you want to talk about what Author-it can do for you, several of us will be there to do just that. Paul Trotter and Steve Davis will also be there to talk about what we’re doing and what’s coming.

Do you want to win an iPad?

This year, we’re giving away an iPad. You know you want one – I certainly do. To get in the drawing for the iPad, we’re doing something special. Late morning Monday, we’re giving out special, limited edition, Author-it shirts in the Author-it booth. You want one of these.

We only have 150 of these shirts, many fewer than conference attendees. To be eligible for the iPad, you need the special shirt. Then you wear the shirt during the conference. At some point, we’ll select a person wearing the shirt and give them the iPad. You don’t know when we’ll do that, so it’s important to always have your shirt on.

Other prizes

If you miss the shirt, we have other prizes we’re giving away, including a free copy of each of the new Author-it books. You could win Author-it Success in 12 Easy steps by John Hedtke, or Learning Author-it by Char James-Tanny. We’re very excited about these books and think you will be too.

Blogging from the conference

I’m hoping – internet connection willing – to be blogging from the conference. We’re certainly tweeting and posting to FaceBook and Tumblr. Watch our social media for what’s happening at the booth, who is winning prizes, and more.

Good luck on the iPad!

I was away last week at a client site, working with them on how to move to Author-it. They bought Author-it because they see the benefits, but, like a lot of companies who are looking to improve their workflow, they didn’t really know where to start. What would be Best Practices for them? How to get there fast so as to not interrupt the current deadlines?

They also wanted to use this move to better architect their content so they got more value out of what they have.

And so we started

We started with looking at the content they had and how they currently use it. They sell large industrial machines that are sold either 1) “as built” with no customizations, or 2) somewhat to extremely customized. They don’t do online help, so we just looked at producing PDFs. Of course, if they need to someday move to help, that’s super easy for them.

They had been doing docs in InDesign and Ventura and had to copy, save, edit, and rebuild every time a customer wanted a manual 2 type. This process took 1 to 3 days, not counting any new content development or any review time.

What they wanted to know was how to go about this process in Author-it. We walked through how to build a book and  then use variants to create the custom books. They got very excited that the 3 days of production would be reduced to less than a day.

Importing existing content

Then we started importing content from Ventura and InDesign to see what that was going to involve. It’s one thing to get new tools to improve your workflow, but if getting the content into the new tool is hard or impossible, that’s something else entirely.

The good news is that getting the content in from Ventura turned out to be super easy – we had the profile set up in under an hour. This is in large part because the docs staff had stuck to a short list of paragraph formats and didn’t play fast and loose. One of the advantages to a team that has been in place for many years is this sort of rigorous adherence to the templates.

The InDesign docs, however, are a different story. People in and outside the docs group created the InDesign docs. The adherence to the template was, well, less strict. We got the basic profile created pretty quickly, but there is going to be some pre-import work needed to put all the text in InDesign into one flow, instead of the adhoc flows it is in now, for example.

Changes to the workflow

Then we started looking at the workflow issues they needed to change to make this all work. The specific details for them are not important to us here, but the big picture is.

They needed to review how they:

• Import existing content – release states to know what’s been roughly imported, reviewed after import, ready to start publishing, and so on
• Develop content – what is truly new content and what should be reused, where to put content, how to know it’s ready for reviews
• Manage existing content – version, variants, release states, and so on
• Structure and locations of graphics folders- where to put overall graphics, product line graphics, one-off graphics, and so on
• Reuse content – what can be reused vs what is currently being reused, where to put reused content, how to name it, and so on
• Review content – how do they send out just the content that actually needs to be reviewed vs all the content in a manual, and more
• Manage localized content – they don’t do a lot but when they need to they need to right now
• Archive content and understand the history – what topics shipped in what manuals when? When was that topic changed and to what?

In sum

Even if you’re not thinking about moving to Author-it, these are all issues you must face when you move from one tool to another. You certainly can just start dumping your existing content into the new tool, but I think that many of the problems you had with the old tool are still going to be problems in the new one.

It takes planning and work to get the benefits of moving to a tool better suited to the problems you’re trying to solve.

I applaud this client for thinking this through and planning the change. It shows real maturity and that the CEO understands the value of their content.

I was really excited to work with this group and know they will be successful.

A visual

I’m including a photo I took the one warm-ish day I was there. My hotel was right on the Spokane River. One day was sunny and I took a long walk along the river to clear my head after a full day of intensive work. It was great. Being a So Cal girl, I don’t see many rivers. Ones with water, anyway.

(The client was not Kaiser Aluminum, I just liked the lovely river area with the Kaiser plant above the river.)

Are you driven to see your clients succeed?

We are seeking a smart, hardworking, talented and passionate project implementation professionals to join our Global Services team.

You are experienced in implementing and configuring content management systems (CMS).You remain focused during implementation projects and handle client requests with professionalism. You are confident when delivering product training to technical communication professionals. You are comfortable when advising clients in knowledge transfer workshops about Best Practices.

You are success-driven and work efficiently with others including Project Managers, Business Analysts, Developers and Support Analysts. You maintain confidence when approaching deadlines, including times when problems have been identified.

You have a history of gathering and understanding your client’s requirements and then using this information to deliver successful implementation/training projects. You’re not afraid of challenges, you are self-motivated and you go the extra mile for your clients. You gain satisfaction from pulling together a demanding project and seeing it through to a successful conclusion.

If this sounds like you, contact us now!

We need people ready to make a difference, so start today by sending us your CV along with a covering brief telling us how you can contribute to our team.

We offer

Author-it Software Corporation is on a mission and you can be a part of this by helping our clients succeed in implementing and using Author-it.

If successful, you will become an integral team member of the world leader in software for authoring, content management, multi-output publishing, and localization. Our client list reads like a who’s who of the global market and includes companies such as Microsoft, Philips, XEROX, Oracle, and HP.

We offer outstanding working conditions, a competitive salary and flexible working hours. This role will involve domestic and international travel.

We will train you on Author-it plus our implementation and project management methodologies. Most of the training will be on-the-job, directly working on “real” projects for our clients. A mentor will guide and support you over the first few months while you come up to speed.

Consultant Global services – Head Office, Albany, Auckland, NZ

Role Requirements

A full position description is available on request.

Soft Skills

• Comfortable in a fast-paced work and cross-functional team environment.
• Work smart attitude.
• Follow directions and established project methodologies as well as display talent for new ideas and continuous improvement.
• Multi-task and prioritise, organized, accurate and detail orientated.
• Dedicated to making a difference.
• Excellent verbal and written English communication skills.
• Self driven with exceptional time and task management ability.
• Dedicated to making a difference.

Experience and Knowledge

• A qualification in a technical field.
• 3+ years practical experience in providing professional services.
• 1+ years practical experience in using Author-it products preferred.
• Knowledge of the content management industry is preferred including familiarity with documentation processes from authoring to managing and publishing content.
• Proven record of delivering client service meeting or exceeding expectations.
• Ability to understand and communicate using “technical” language.
• Competence in delivery of training (remote via web-meeting and onsite).
• Competence in writing technical publications preferred, e.g. user manuals, help systems, or knowledgebases.
• Competence in Microsoft Word (2007, 2010 including word macros), web technologies (e.g. HTML, XHTML, CSS, XML).
• Competence in windows environment (e.g. AD groups, server environments, VM).
• Prior stable work experience.
• Authorization to work in New Zealand.

Preferable

• 1+ years’ experience using Author-it.
• Knowledge of the content management or technical publications industry.
• Familiarity with the documentation processes from authoring to managing and publishing.
• Authoring background with other technical communication products.
• Competence in Help systems (e.g., HLP, CHM, Web Help, Java Help).
• Knowledge about industry standards (e.g. SCORM, DITA, S1000D).

Client Care Consultant (US-based)

Role Requirements

A full Position Description is available on request.

Soft Skills

• Comfortable in a fast-paced work and cross-functional team environment.
• Work smart attitude.
• Follow directions and established process guidelines as well as display talent for new ideas and continuous improvement.
• Able to multi-task and prioritise, you are organized, accurate and detail orientated.
• Excellent verbal and written English communication skills.
• Self driven with exceptional time and task management ability.
• Must have the attitude of “How can I make things better” and “EXTREMELY satisfying Client service”.
• Ability to build and maintain good relationships with clients.
• Dedicated to making a difference.

Experience and Knowledge

• A tertiary qualification preferably in a technical field.
• 3+ years practical experience in delivering professional services and/or client support in the software industry.
• Proven record of delivering client service meeting or exceeding client expectations.
• Ability to understand and communicate using “technical” language.
• Expert in assisting clients on the phone.
• Ability to analyze requirements and find client focused solutions.
• Professional in complaint management, effective escalation management.
• Competence in all Microsoft products (Word, Office, Power Point), web technologies (e.g. HTML, XHTML, CSS, XML).
• Competence in windows environment (e.g. AD groups, server environments).
• Prior stable work experience.
• Available to work 40 hours per week and work a shift arrangement to accommodate all US time zones.
• Authorization to work in the United States.

Preferable

• 1+ years’ experience using Author-it.
• Knowledge of the content management or technical publications industry.
• Familiarity with the documentation processes from authoring to managing and publishing.
• Authoring background with other technical communication products.
• Competence in Help systems (e.g., HLP, CHM, Web Help, Java Help).
• Knowledge about industry standards (e.g. SCORM, DITA, S1000D).

To apply

We work hard, but enjoy our work and there are some great perks to being part of the Author-it team! Join our global team with members in Europe, Middle East, Asia, Australasia and the US – take your first step today!

To apply, email: ralf.wittgen@author-it.com.

No 9-5vers please; we need consultants who are fully committed and want to make a difference!

No recruiters please!