websites – TechCommGeekMom

While I haven’t been an official content strategist/publisher for that long, I actually have been web publishing for a long time now. Over the years, I’ve learned the difference between good practices and bad practices, from experience and through classes and webinars I’ve taken. I’d like to think that from all of this that I’ve learned to be a pretty good content strategist and web publisher. Even so, I still don’t understand why people find content strategy difficult to understand, and why creating a high standard of quality in content strategy and publishing content that’s user-friendly is so difficult. It makes me want to pull out my hair it frustrates me so much!

A recent occurrence of this lack of comprehension spurred my intense frustration again. I’ve experienced this before in many places that I’ve worked, but this was just the latest occurrence that sparked my ire. Among several projects that I’m working on at work, one of them is managed by another web publisher. In our project, we’ve been assigned to revamp a current internal website. Par for the course–this is what we do. The project manager was given an outline by the internal client, along with the main content, which included documents to be linked within the pages. That sounds fair enough. Of course, as most technical communicators know, content written or planned by non-technical communicators usually needs some help to make it more user-friendly. In this case, much of the formatting of the content was…less than desirable. In addition to making the outward facing part of the microsite user-friendly, we also had to make the back end–the organization in the content management system–user-friendly as well, since the client would be maintaining the site after we were done setting it up. This all sounds like a reasonable task, and a technical communicator would be just the person for the task.

However, I found myself frustrated with the process, or rather, the quality of what was starting to go up. The project manager gave me sections of the website to work on and format. I found it difficult to decipher the client’s outline because the outline was written poorly. Nevermind the actual text itself, which wasn’t always well written either. I couldn’t really touch that. The outline was meant to help the web publishers–the project manager and I–understand how the client wanted the site organized. At a high level, the main outline seemed fine, but when getting into the finer details, it easily fell apart for many sections. I often had to consult the project manager for clarification, as I wasn’t supposed to be talking to the client directly, for some reason. Whatever.

The other problem was that nothing was labelled in a way that made sense or was user-friendly for use on the front or back end. I can understand that people have different naming conventions for files that make sense to themselves. But when creating the name of a file that is some sort of document or form to be used by others, and not giving the document a title? I don’t get that. For example, if the document is a quick reference guide about how to use your Lotus Notes account, then the text on the web page should be something like,

Quick Reference Guide for Lotus Notes

and the file on the back end should be called something like, “QuickRefGuide_LotusNotes.pdf,” or something like that in order for the user to understand what they are downloading. The file shouldn’t be called something like, “QFC-LN_ver1_01.02.14.pdf”. Down the road, someone will look at that downloaded file and question what that file is. Wouldn’t it be easier to title the file more appropriately rather than have to open it? I’m sure some would argue something about versioning here, but in our CMS, there seems to be a bad practice of putting many versions of the same document up with different names rather than utilizing the versioning function of the CMS. I use the versioning function on the CMS extensively on the other sites I work on, so this confuses me that others think it’s okay to clutter up the system with many versions of the same file under different file titles.

To add to the grief, the client sent files in zip files which yielded unorganized folders and files as well. In this instance, the project manager would keep the folder convention the client had given, even when it didn’t make sense. When I questioned the project manager, I received the response of, “The client had them organized that way, so we’ll leave it because they’ll be maintaining it later.” NOO!!! The organization didn’t make sense, it didn’t follow the client’s own outline, and complicated the back end so that it didn’t make sense! I am confident that the client just slapped some folders and files into a zip file, and sent it along for us to decipher it. I spent the past year cleaning out another department’s very large microsite doing just this–giving files more appropriate names and creating a folder system that would make sense to ANYBODY going into the site to find the page or document needed that followed what was on the front end. And now, when changes need to be made, it’s easy to find the appropriate documentation.

As I’d do the pages I was assigned to do for this new microsite, it became clear to me that the project manager didn’t care. Granted, it’s a big project, and we want to get it done quickly. It would be easier to be able to merely cut and paste content into the site and be done, but it’s also our responsibility as content strategists and technical communicators to make things easier, more streamlined, more user friendly for both the front end and back end. The mantra for all technical communication is always user advocacy– for all aspects of the project, whether it be digital or print.

This means that there needs to be attention to details, thus the “copy and paste” method of entering content into a CMS system alone is not enough. I used to be known at one job as the “Table Queen” because the CMS used didn’t like the copy and paste of tables from Word, so I usually had to go into the HTML code and fix everything so it displayed correctly–or if I could, make it display even better. Tables are something simple to figure out in HTML, but even so, it was something that other people at that particular job with the title of “web publisher” did not know. (They didn’t even know HTML at all, so why were they called “web” publishers?) It was important to make the pages look consistent and be organized in a way that would allow the users to find information quickly and easily.

In this project, I’ve found that the project manager isn’t taking the lead in setting the standard for the website. I’ve been disappointed that the same standards that I would expect aren’t being displayed by this person. It frustrates me, but like I said, it’s not the first time I’ve encountered this reluctance to make a website work.

Do understand that I’m not a perfectionist. I let things slide to a certain point, too, and post things that are “good enough”. But in the end, it comes down to the foundation of the website. If the foundation and the building blocks aren’t sound, it’s not going to hold up. In content strategy, if the infrastructure of the site isn’t sound, and the content isn’t well defined, then the website will reflect that disorganization.

Content strategy, at its core, is really easy. It’s all about organizing information in a way that it can be easily searched and retrieved. It’s about labelling files and folders so that they make sense. Val Swisher’s analogy about content strategy being like one’s closet still stands at the heart of it. If you can organize your closet and identify the different clothing pieces in order to categorize them, then you understand how to do content strategy. The only difference is that instead of having shirts, skirts, pants, and shoes to organize, you have folders of documents, webpages, and multimedia. The method of making sure that users can find those documents, webpages, and multimedia should be streamlined, clear, concise, and user-friendly. As content strategists and user advocates, it’s all about making sure that what the audience is viewing looks and reads well, and what the content managers can maintain easily.

Ultimately, when creating a content strategy and setting it up for maintenance, do it correctly now, even if it’s time consuming. If for no other reason, it’ll save time and headaches later. It’s not difficult. It’s just common sense.

For this week, I decided that I would post another one of my “Blast from the Past” entries from my graduate school blog. When I go back to review these, many of which were written when I was just starting to understand what technical communications were all about, I see some pretty decent reflections.

I’ve lost direct contact with the person in this entry, as life moves on, and Twitter exploded, but I still learned a lot from the experience. Perhaps I still need to follow-up on the blog entry I proposed at the end based on his books! He’s still out there and making the most of social media and media at large, and has always been ahead of the curve in this regard, continuing to make the most of both marketing communications as well as instructional design with his television shows and now instructional videos on his website.

Enjoy this entry that was originally from March 20, 2010, originally titled, “Interior Design Influence on…Web Design?”:

Recently, I’ve struck up a Twitter friendship with renowned interior designer, Christopher Lowell. He is a very thoughtful, sweet guy. He also posts these great dishes he’s having for dinner that make me hungry! But I digress…

Christopher has always been a little bit ahead of the curve when it comes to media and the wave of the future in communications. He was revolutionary in breaking down the basics of interior design in a user-friendly way, and bringing it to the public on the then-new media outlet of cable television. Between his shows and his books, which eventually branched out into his own product lines of furniture, fabrics and other home accessories, his goal has always been to make interior design about making a home, and making it with your own special stamp. All these years later, he still has that goal of bringing things that seem so lofty down to earth for all of us to enjoy.

One of the things I like about corresponding with him through Twitter is that he really seems to be exactly who you see on TV and read in his books. He’s down to earth, he can be silly, but he really does care about important issues and cares a lot about other people and really using social media as a means of communications. I know that I’ve certainly enjoyed getting to know him little bit by little bit.

So, today he posted on Twitter that he had a new blog post, in which he talked about how he likes how reality TV is starting to be used more constructively, and used Jamie Oliver‘s show about how Jamie is trying to change the diets of school lunches to more wholesome foods for kids as a good example. He segueways into how he feels that the internet is what the next big wave of information and entertainment will be– more so than it is now, much like cable TV was in its infancy. He alluded to the fact that part of the reason we don’t see him on TV (cable or otherwise) much these days is that he’s exploring these new media. He wrote, “As we continue to open new portals and refine new media platforms, you can bet, I’ll be there, doing what I do best.” That seems appropriate for a guy who has always been on the cutting edge of things.

So what does this have to do with technical writing? Well, a lot. You see, I feel inspired by what Christopher has been talking about, because it’s not only about what he’s doing, but where the future in technology is going, and technical writing is part of that. I’ve thought of two projects that he’s inspired me to do, but I don’t have the reason to do it other than “just because I feel like it” at the moment, so since I’m busy enough, I’ll have to wait until I have a little more time to work on them, or can work it into a school project for my e-Portfolio. The first idea was just to interview him, and get more details of where he thinks internet media is headed, and the sorts of projects he wants to do, or sees happening. You know, get inside the head of one of the big “movers and shakers” to understand future trends. The other idea is to write a piece called, “The Seven Layers of Technical Writing” or “The Seven Layers of Web Design,” or some similar theme, as Christopher was the one who revolutionized the idea of the “seven layers” of interior design. (Heck, I wouldn’t be surprised if he invented the Seven-Layer Dip!) In my mind, it would be an article that would show, especially for the newbie technical writer, that by sticking to some basic rules of thumb, like the Seven Layer of Design, that you too can master what it takes to be a technical writer. I’d really have to think it through, because I’m sure it’s not that easy to whittle anything down that has so many variables, like tech writing, like web design, or interior design.

Kudos to you, Mr. Lowell, for giving me some inspiration outside the (technical) box, and getting a new dialogue started in my head…