Maxwell Hoffmann, circa 2013 Photo credit: D.M.Villegas
Simple A’s Maxwell Hoffman happens to be a good friend and mentor of mine. I’m lucky and honored to have him as one of my cheerleaders. Maxwell recently wrote and excellent article about structure and semantics for context in content for Simple A’s blog and for the ISTC.
His article starts, Content becomes intelligent, flexible, and capable of scalable personalization through structure and semantics.
Content drives customer experience (CX). In order to achieve optimal CX, we need the ability to manage multiple variations of content components that are dynamically assembled as relevant experiences, based on the context of the customer’s touchpoints. We need the ability to create a content component once, then reuse and deploy it many times, in many ways. This requires structured content with an intelligence shaped by semantics.
Structuring content within a well-defined content model makes content scalable, reusable, adaptable, and measurable. We cannot create real-time, personalized conversations at scale without structured, intelligent, semantically rich and truly accessible content.
He continues the article breaking down how we can create content models based on reusable content (do I hear DITA?) and how we model content has direct impact on user and customer experience. This is the foundation of intelligent content, if you think about it.
It’s a well-written article, and I highly recommend that you take a look at it.
This is a big part of my job right now, and this is an excellent way to clarify the difference between what a thesaurus is and taxonomy is. Taxonomy really is about the organization of the content so that the hierarchy makes sense.
Another analogy that I’ve used–which I got long ago from Val Swisher of Content Rules is how one can organize a closet. You can put the pants together, the shirts together, and the jackets together, but you could put all the red clothing together, all the blue clothing together, etc. Neither way is wrong, as long as it makes sense and others can follow the flow.
Except with me these days, it’s more about pharmaceutical departments and procedures. Still, even with those topics, we need to scale it back all the way to what are the objectives of the website we’re building, and how do we structure the website so that users can find what they need quickly and easily. Start with the foundational basics, and build from there.
I highly recommended this article if taxonomy isn’t your strength. It shows that it’s not as hard as it seems.
I know you haven’t been in the Delta Quadrant. So where have you been?
OK, so it’s been a while. I know. While I wish I could say that I’ve been on an Intrepid-class Federation starship named the U.S.S. Voyager, sadly that is not the case.
It’s a little hard to be writing blog posts when a) you don’t know exactly what to say after having written hundreds of posts before, and b) you’re just REALLY busy.
2016 was a rough year, but 2017 has also had its challenges so far. You know that I’m always in some sort of work search mode, and that’s already had its ups and downs for the past few months. I was excited to get my first independent contract. It was an opportunity to finally flex my e-learning muscles, and do it on my terms. I started to create a curriculum matrix, to make storyboards, to write transcripts, test questions, and study guides, and created video training–21 completed videos in about a month. But the contract ended before the full project was completed, and I don’t know what will be happening going forward. There was a big learning curve involved, and after the fact, I’ve realized where I made some wrong moves, but I also learned where I made many right moves as well. I’ve been mastering TechSmith’s Camtasia during this time, and feel pretty comfortable with it now. I sometimes feel I missed out on one of my many callings as a video editor (although you never know–that might change going forward). I know that I was producing good content, if I say so myself, so I have to be satisfied with that for now.
I also was the co-chair of the STC-Philadelphia Metro Chapter (STC-PMC)’s annual CONDUIT conference. Thankfully, that came off with few hitches, and it was well received by everyone I heard from. Some people hadn’t been to the conference in years, and it was a great opportunity for them to see how our conference has grown! Next year, at this point, it looks like I’ll be the main chair for the event, so it’s going to feel a little overwhelming, I’m sure. Just being co-chair felt overwhelming at times, while trying to work with client deadlines. It stressed me out enough that I even got physically sick for a while. For CONDUIT, the payoff is worth it, and I hope that everyone who is reading this considers coming as a presenter or attendee for next year.
Oh, and I can’t forget that I’ve been studying my DITA by helping someone who is writing a book about it, and I was asked to contribute edits as a beginner who wanted to ensure that they understood the author’s instructions. That was cool, and helpful.
Kim: Is she kidding us? Overwhelming? Paris: That’s what she claims. Who am I to argue?
All through this time, as I said, it’s been a bit overwhelming. I realized some missteps with all of it the hard way, as I usually do, but thankfully I have a lot of good people who help me get back up and fight another day. (Photon torpedos are loaded, Captain.)
I spoke to veteran tech comm consultants at CONDUIT and through Single-Sourcing Solutions’ TC Conclave, as well as just talking to other technical communicators when I had the opportunity offline. All have provided me with advice about how to move forward in the future as an independent consultant, and massaged my ego just enough, knowing how battered and bruised I felt at times. For that, thanks to all of you. You know who you are. This is why I get involved with the STC and with other technical communicators. Five years of networking is finally paying off–you know me, I know you, and I can learn more about things that they don’t teach you in grad school. I benefit from your experiences and I’m grateful.
Kim: I think we should take a ship-wide survey or start a betting pool on what she’ll do next. Who’s in?
So now the question is…what do I do going forward? I’m in limbo once again with timing, figuring out what to do next. At this writing, I’ve decided to lay low for a couple of weeks. I’m concentrating on my VP duties for the STC-PMC for the rest of this program year (two more main events to go right now!), reworking my consultancy’s website (a project temporarily postponed when I started my contract in February), and doing a little bit of project hunting, but nothing too deep just yet. I have a few leads on things, but I’ve always been hesitant to “count my chickens before they are hatched,” as the saying goes. I’m looking forward to attending the STC Summit in a few weeks in Washington, DC. I’m getting excited about going, because I realize that it’ll be nonstop tech comm for me almost from the moment I get there! I’ll be with my tribe! I plan to take advantage of seeing all my STC friends–and making new ones as well–in the hopes that my continued networking will help me build my business. I’m looking at things through a slightly different perspective now.
In some ways, I’m still scared to death being “on my own”. Having survived through my first experience without an agency, though, was exhilarating, and I liked being my own boss and calling most of the shots, and determining how things should be done. I was able to validate that in many ways, I’m still on the right track, even if things are slow-going right now.
Kim: Captain, there’s something out there! Janeway: I need a better description than that, Mr. Kim!
I still have a very long way to go, but I’ll find my way eventually. Sometimes I feel like the very green Ensign Kim, who has some knowledge, but still finding my place while trying to make a difference. Sometimes I feel like Captain Janeway, where I feel like I can lead and figure out what needs to be done. There will be Borg, Kazon, Vidiians, and Hirogen to battle along the way, I’m sure. Hopefully my persistence moving forward will get me where I need to go, even if it takes a while.
Really, Father, my only sins are beer, donuts, beer, donuts, not knowing DITA, beer, donuts…
“Bless me, Father, for I have sinned! I am a failure in technical communications.”
OK, perhaps in many eyes, I haven’t been a failure in technical communications. It will be five years this spring since I graduated with my Masters degree in Professional and Technical Communication from NJIT. In many ways, that feels like it was just yesterday, and I’m still a “new graduate”. But with the change this year in my STC Membership that’s moved from “Student” to “New Professional” to “Classic”, I supposed I’m not anymore.
While graduate school gave me a good foundation to move forward, I learned very quickly that I needed to continue to educate myself. As I attended conferences and presentations, and paid attention to discussions in social media, I found out that graduate school lessons barely cut the surface. I’ve tried my best to continue my studies by attending as many webinars, conferences, and presentations that I can. I even took another university graduate certificate course on digital marketing, hoping to get some insight that might help me going forward.
However, in the end, I failed to do one thing that might actually boost what I’m doing as a fledgling content strategist, and thus, my confession: I needed to learn DITA.
For those of you who don’t know what DITA is, it’s the acronym for Darwin Information Typing Architecture, and it’s a commonly used method for creating structured authoring using XML coding. The idea is that documentation done using DITA methods will allow for single-sourcing for content elements, and equally make it easier to integrate that content into print or digital outputs in a super-organized, modular way. It’s a standard that helps because it’s generic to almost any system out there. Any system that can read XML can read a DITA document, for the most part. When moving from one system to another, the content can stay intact if done using DITA/XML methods.
I don’t remember learning much about DITA in grad school, other than understanding what it was in general as I explained it above. I never learned the details. In my work life so far, I haven’t needed it. It’s always been unstructured authoring. I try to take some small steps to create some single-sourcing content when possible in content management systems, but that was hard to do sometimes. One of my recent jobs made me realize that we needed some sort of structured authoring done, but I didn’t know how to go about it. We created our own coding tags to describe things going on in copy decks. It wasn’t the best, but it was better than nothing.
In the past year, I’ve tried to figure out ways to continue to improve my skills, and make myself more marketable as a content strategist/content manager. I talked to the leading experts in the field. (It’s one of the benefits of getting involved with the STC and attending STC events–you get to know these people personally.) And the one thing that seemed to come back to me again and again was that I had a good resume, and I have some great skills under my belt, and they knew that I was a good writer from this blog. The biggest sore spot in my skill set was that I lacked an important skill–knowing DITA and using it. And while I looked for jobs in my area that included DITA practices (I think I’ve only seen one listing in three years), I’ve been assured that if I could learn DITA, the remote/telecommuting possibilities could be much better for me. And since remote opportunities are my best bet right now, I have to do what I need to do to make that happen.
So, as the saying goes, I bit the bullet. Fortunately, the STC was promoting a course about DITA Essentials taught by Bernard Aschwanden, the Immediate Past-President of the STC, and the proprietor of Publishing Smarter. Bernard’s a great instructor, and he’s taking it nice and slow. One of the best parts of the course is hands-on experience, even if it’s in the simplest ways. That’s the way I tend to learn best–learn the logistics of how something is done, then I need to learn to do the work through trial and error. Last week’s assignment was particularly challenging for me. While I understood what I had to do conceptually, since I was also trying to familiarize myself with a few XML editors at the same time while applying what I wanted to do with my assignment, I got very frustrated. I sent in my assignment, along with notes about where I was getting frustrated and needing some guidance. Bernard assured me that all would be well, and asked me if he could use what I had turned in for my assignment for the most recent class. He also warned me to have a glass of wine ready while taking class, because I’d be needing it. Yikes!
I was told to prepare for the onslaught of big corrections to my DITA homework with a glass of wine. I took the suggestion seriously, thankfully.
The glass of wine was done by the end of the class, and yes, he ripped my assignment apart, but it was okay in the end. I knew there were problems with it, and he showed me where my original thought process was correct, but I didn’t know how to execute it properly. One of the mistakes I was making was my use of XML tags, particularly using the correct ones. While the XML editing apps all have guidance features to help you with using correct tags in certain situations, I still wasn’t using the best choices. Most of that was because I’m not familiar with what these XML tags mean, so I was using them at face value. For example, I was using a step example tag in part of my content, and Bernard understood why I used it, but felt that the way I used it was incorrect, and didn’t allow for cleaner coding. Okay, I can deal with that, especially when he demonstrated the correction.
So, as much as I’m struggling with DITA, I do understand the essential concepts behind it now. My biggest problem is learning how to use it beyond the most elementary tasks. I haven’t had any “real world” scenarios to date when I could implement and learn how to use the XML editors and use DITA practices in writing or rewriting content. I need to figure out how to find content and start having a way to truly play with something so that I can get the full experience of that trial and error to master DITA.
After the STC course that Bernard is teaching, I plan to follow-up with Scriptorium’s DITA tutorials as well, and see if I can learn some more about XML coding. I have a lot to do to figure this out, but I know that in the end, this will be a big skill that will make a lot of difference in how I approach content. The content strategist skills I already have acquired have helped me frame DITA much more easily than if I learned this with no prior knowledge. But, I can tell that I still have a long way to go before I feel that I’ve mastered this.
So, this ends my confession. I have needed to learn DITA. If it’s not taught in university classes in technical writing, it should be. I think it would have saved me a lot of frustration, and provided more opportunities for me sooner. If I can get a better handle on this, I’m hoping that I can start exploring how XML Editors can integrate with CMSs, like Adobe CQ. I’m not an Adobe AEM developer (I’m not a developer at all!), but I know how to create websites and pages with AEM, and hopefully I can start figuring out how to integrate those skills with DITA skills. I was told by one mentor, that would make me a very desirable job candidate, and I think she’s onto something. Of course, I need to brush up on my AEM skills, since it’s been a couple of years since I’ve used them regularly, but with all things, once you master them, it’s like riding a bicycle. You might be a little unstable at first, but you never quite forget how to do it once you get started back into it again.
Here’s hoping that in 2017, DITA will become a “bicycle” skill for me. I’ll go say a few rounds of the Rosary in the meantime for my penance.
(What do you think? How important is DITA in technical writing? I’ve heard some say it’s a passing trend, and others say that its usage continues to grow. Include your comments below.)
Oh, when I read this, I knew this would appeal to the history geek in me, while also satisfying the tech comm geek in me as well. When the click bait of this article says, “What do Alexander Hamilton, Harry Potter, and Bayesian Statistics Have in Common?”, you know I went for the bait. And knowing that Alexander Hamilton’s reputation is becoming more relevant thanks to the Broadway musical, “Hamilton”, I thought this would be relevant to share.
Not only did I come away with a cool story about The Federalist Papers and statistics, but the thing that kept coming back to me was how tech comm has become advanced enough that we use many of the same techniques in content strategy now. To be more specific, Mark Lewis and his talks and book about XML metrics instantly popped into my head, and how we use similar statistics to figure out how to economize our content, and provide the best ROI for the content that is created.
Read this article, then go back and read my articles about Mark’s talks about XML Metrics here and here. You’ll see where I was making a connection.
What do you think about this? Do you think that The Federalist Papers project laid the groundwork for XML metrics and other metrics we use today in tech comm? Why or why not? Include your comments below.
TechCommGeekMom 
You must be logged in to post a comment.