WordPress Rules! Goin' to WordCamp …
Oh boy. I feel like a kid at Christmas. I’ve signed up to go to WordCamp Seattle, taking place next month. That’s because, of course, WordPress is the coolest thing ever. I think that every tech writer needs to know it. How I ever lived without it before now I can’t say. I could easily see it being used for docs. Toss some words up on the blog. Collect comments for said entries; engage the users. Tag items and automatically sort them into categories for archiving. Add pages and subpages and more. Import a Twitter feed or two. Dig away; use the Search box to sift through the content. Wow. What possibilities.
WordPress has tons of functionality. It’s open-source, and people are constantly developing plug-ins and themes that can be used by anybody. It’s collaboration on a grand scale.
Collaboration. That’s the future. That’s WordPress now.
Sit back and take a long look. Not just at WordPress itself, but at how it’s developed and maintained. See how everyone contributes themes and plug-ins. Start thinking of your docs as becoming open-source. What can you develop? What can we, as tech writers, do to make it easier for users to generate their own content, to join the conversation, to collaborate? It’s not enough to just think about and advocate for the user. We have to throw open the doors and let them in. We have to build the framework that allows the input.
The Changing Roles of Writers and Editors
As my friends and family know, I’ve been mesmerized of late by a box of old letters I had stashed in my closet. The letters were from long ago – the late 70s and early 80s – before computers were in use, and definitely before e-mail.
The letters are a joy to read, as they recall wonderful memories and good times with people I’ve not seen in some time, or those I’ll never be able to visit again. Letters were often written over a period of days. Started, put down, picked up a different day. And then that was repeated, until the letter finally found its way to the mailbox.
In stark contrast to this is the technology of today: computers, e-mail, phones. We no longer write letters; we write snippets. In social media, we’re limited to the maximum character length allowed. Server capacity rules. Database limitations rule. Bandwidth matters. Plus we’re all in a hurry, so there’s not much time for reading, let alone writing.
How this applies to tech writing I haven’t completely figured out yet, but I have some ideas. I know content will be more snippet-like with quick delivery and review in mind. Finding, gathering, and monitoring the info is what will gain in importance. How much time will writers spend developing material, and how much time will be spent in searching the airwaves for existing material, determining what’s applicable and useful, and delivering it to users? How can we direct this burgeoning cloud of content?
Folksonomy – Taxonomy – Tags
Everybody puts some sort of tag on their content. Look at any post on any blog and you’ll see tags. What the tech writing community needs to do as a whole is determine some basic tags for all of us to use. This will ensure some consistency, make it easier for people to think of which tag to choose and then apply it, and provide more focused results listings. I’ll write a post and start listing some. Let’s get started.
Editorial Boards
Someone has to moderate all the user-generated content. The role of editor may be expanded from reviewing work of writers only. Writers will still need to prepare information of their own. They will also need to review what others develop to help ensure accuracy – to a point. They will undoubtedly need to look the other way at times, as the freedom to prepare one’s own information must be retained and to ensure that other points of view are represented. However, there will be times when it will be necessary to remove or delete some content. That’s where an editorial board comes in. Set the rules. Establish guidelines for submittals and content. Determine procedures for correcting or removing information. Establish your board now and get busy.
Make it Quick – Whip up a Video
Sure, there are times when it’s preferable to create a planned, long, official nice-looking online tutorial. Much of the time, though, I think you could just take out your little video cam and whip up a gem of a demo. Do we really need to have everything completely scripted and approved and run through the whole process? No. Definitely not. Not everything needs to be polished. Some videos could just be made in minutes and uploaded in seconds. They can’t – and shouldn’t – be too long in duration. For in-house uses in particular, it may be all that’s necessary. And if it’s wrong or outdated? Simply pull out the camera and make another one.
. . . . . .
After reading my letters, I’ve decided to turn off my computer sometimes and write some nice long letters to friends and family. I’ll save my snippets for another day. I don’t want to give up those snippets, but they’re like fall leaves being lifted off the sidewalk by cooling winds: there one moment, gone in the air the next. They’re meant to be momentary. Letters are meant to last.
Tech docs are not meant to last. The technology being discussed is changing so fast that the content is quickly rendered obsolete. People do not want to read that much any longer. We have to be fast, nimble, and prepared to gather, review, and move content quickly.
Wikipedia to Add Editable Video Functionality
Game over. Print is on its way out. I just read an article about Wikipedia adding video functionality down the road that will enable people to edit videos.
I’ve been figuring that video is key, and that people would take some video already made, come up with their own version, and post it somewhere. I’ve seen such videos on YouTube – not for docs, but for other topics. Functionality for people to “annotate your video, edit your video, and improve upon it–in the same way people have been doing to your text posts” makes it a whole new ball game.
See the article in Technology Review:
Wikipedia Gets Ready for a Video Upgrade
A New Doc Strategy
In years past, a doc strategy was fairly straightforward: prepare print documents that were either in binders or printed into a book. Then came online help, so both were used. Then PDF was added as an option. For many, that’s as far as capabilities have progressed.
The new reality is that technology is rapidly changing and different methods of access are popping up all the time. Print and PDF, to some degree, are going to fade away. Some sort of online version will endure, but it won’t be what we’re accustomed to.
To wit, here’s yet another example of new technology: bendable, paper-thin screens and mobile device screens that “roll out” to a larger size.
http://www.technologyreview.com/computing/22232/?a=f
http://news.cnet.com/8301-10784_3-9891347-7.html
How cool is that? And how will it affect or impact overall documentation strategy? If you’re developing for mobile access, but the screen can enlarge, but is likely still smaller than a desktop screen, how do you design your docs for all?
These are the sorts of questions that will continue to arise. The simple days of print, online help, and PDF are gone. The idea of a “document” may even fade away.
If I were developing a doc strategy today, I would have the following elements, at the very least:
- Use xml and databases to produce content that can be accessed over intranets and the Internet, including portals such as SharePoint
- Design for mobile devices
- Use online forms to set up docs so that they can be directly input to a database
- Use content management strategies to review, design, and write content accordingly
- Set up video libraries (such as YouTube)
- Use Twitter for tech support and to push information and updates to users
In With the New: Video
“Everything is on YouTube.”
So stated my son the other day, in response to a comment about looking to see if something might be there. I’d have to agree with him. Every time I look for something there, I’m surprised. The fact that younger kids think of YouTube as a primary source of information also gives pause.
For a while, I’ve been looking at videos on YouTube and other sites with tech writing in mind. What jumps out is that people use videos in varied, unexpected ways (to me, at least). It’s not just that people are creating videos and putting them up there. They’re also taking news broadcasts and movies and making them their own. For movies, I’ve seen videos where people have taken their favorite scenes, put them together, and added music. While some are similar, you can see that each person gives theirs a slightly different slant or uses different music. What’s important to one person is not so much to another.
Now think of that related to tech writing. You’ve researched a topic, talked to SMEs, and written something up. Still, it’s your slant on what’s most important. You’ve been trained what to look for, how to organize content, and how to prepare the info. With this usage in YouTube in mind, someone could just take what you’ve written and make their own version. Assume that users will (a) make their own videos, and (b) take something already made and create a new version. In may be from something in-house. Perhaps it may be from an external source. This has tremendous potential. Combined with comments, it could provide a wealth of information.
By now, I imagine (I hope) that companies are either using or already in the process of setting up an internal video site along the lines of YouTube. For documentation departments, I believe now is the time to try and move that along. The process may take a while to run through a company. There could be a number of issues to work out: technology requirements, security, processes, and usage guidelines are possibly a few.
We’re always the voice for the users while an app is in development. I believe that we now must be the voice for the users coming in that will expect to be able to post and review job-related videos.
I believe that the role of tech writers will change. We may shift more into content management and development of enterprise information and moderator of user-generated content. There will still be procedures to write and doc sets to create. We’ll just need to make room for whatever comes so the voice of the user is heard. All can participate. I’m looking forward to it.