BMC Communities Banner

- By Michele Marques, Lead Information Developer, ITSM

 

One of you readers asked (by email), "What is the definition of documentation?"

 

Dictionary definition

Dictionary.com provides a few definitions. The first two have to do with evidence to substantiate claims. If you're not working on technical communications, this might be the sort of documentation that you produce at work - documenting work performed as you resolve incidents, investigate problems, and complete other tasks.

 

Their third definition states:

manuals, listings, diagrams, and other hard- or soft-copy written and graphic materials that describe the use, operation, maintenance, or design of software or hardware

This definition is more in line with what I produce as a technical communicator.

 

Traditional documentation

Traditionally, documentation has included manuals (printed and PDF) and help systems.  As I've mentioned before, I like manuals. I've entered a BMC Remedy IT Service Management Suite manual in the Society for Technical Communications competition and won a merit award.

 

What about new directions?

But just because we're used to producing manuals and help systems doesn't mean that this is still the best way. Personally, when I get a new car or phone, I spend time going through the manuals - I want to learn about all the features. But when I get stuck, I'll turn to forms, Google search, and Youtube videos.

 

Can documentation be delivered in social media?

A couple of years ago, I asked whether facebook could influence technical communication. This past week, I attended a session at Social Media Week about navigating user-generated content. Personally, I think that finding a way to integrate user-generated content with documentation is a great idea. Sure, we technical communicators understand how the product is supposed to work. But users can tell us about the challenges they face and how they're using the product.

 

Forums and blogs provide an opportunity to interact, but is this really documentation? I could blog about software license management, But if you're trying to learn more about using this features of BMC Remedy Asset Management, are you likely to turn to my blog? Perhaps if you turn to a search engine and pull up my entries.

 

Videos are available from many sources. Everyone's familiarity with  YouTube. BMC provides videos on BMCtv. Both the community and BMC provide videos here on the BMC Developers Network.  Are they documentation? The video BMC Atrium Core 7.5.00: Taking Your Data Into Production End to End received a comment from one user, "This is the best, most helpful doc I have seen on Atrium Core." When do you turn to video?

 

 

Wikis prodivde organized information. With the acquisition of Tideway, BMC Atrium Discovery documentation is now available on a wiki.

 

Firefox provides a wiki-like knowledge baseby allowing users to edit articles. I like the front page, which guides you to search, popular articles, and a section for new users. Do you have a favorite wiki or support site?

The postings in this blog are my own and don't nessarily represent BMC's opinion or position.
| More
0 Comments Permalink

Correction

Posted by mmarques Jan 22, 2010

Oops! Apparently the local setting on my blog has no effect, because there's a global setting for all BMC blogs. So, it looks like you have to join the BMC Developer's Network to leave a comment.

 

However, if you join the community, I think you'll find it worthwhile. In addition to our blogs and podcasts, you'll be able to participate in forums, where people discuss our products, investigate ITIL implementation, participate in an open source community, and find out about new social media initiatives.

 

Sorry for the confusion!

| More
0 Comments Permalink

- By Michele Marques, Lead Information Developer, ITSM

 

A couple of weeks ago, I mentioned that most of you aren't leaving comments on my blog. I found out from one person (via another communication channel), that he didn't want to create an account with the BMC Developer Network (BMCDN) just to leave a comment. I think you're missing out on a great community if you're not part of BMCDN, but I realize that not everyone wants to join.

 

Well, I changed the blog settings, and now anyone can comment. If you're not logged into BMCDN, you'll have to leave your email address. Also, to help prevent spam comments, comments are on hold until approved.

 

If you've been holding back on commenting, please speak up! Your voice is welcome. And if you're using the BMC Today iPhone App, can you let me know if this new setting now allows you to comment?

 

The postings in this blog are my own and don't necessarily represent BMC's opinion or position.
| More
0 Comments Permalink

There's a lurker on my blog

Posted by mmarques Jan 8, 2010

- By Michele Marques, Lead Information Developer, ITSM

 

The odds are, if you're reading this blog post, you're lurking - namely, reading what I have to say without joining the conversation. But don't worry; you're in good company. Most people don't leave comments either. In October 2008, I asked Are you reading this page? But, I can see from the statistics, that far more people read than comment.

 

When do you respond to a blog post?

On my personal blog, I got a record (for me) number of respondents when I posted a survey asking What year do you think it is? (do you call the current year "twenty ten" or "two thousand ten") I think the quick multiple choice format made it easy for many people to respond, and it's a subject on which everyone has some expertise.

 

How do you measure popularity?

In What's your favorite JustWriteClick post? Anne Gentle mentions that you can define a blog post's popularity by the number of comment, number of views, or number of average daily views.

 

What makes a post popular?

In More cowbell, Sarah O'Keefe notes that readers seem to like clever headlines and opinions (especially outrageous ones).

 

I've read that blogging more regularly helps attract more readers (making all posts more popular), and Alena Hitzeman provides 10 Tips for Staying on the Blogging Ball. One of her tips is to put time on your calendar for blogging. I don't know if you've noticed, but I try to post on Fridays. Sometimes I get busy, but I agree that having that item on my calendar makes it more likely that I'll actually post something during the week.

 

Of course, I don't expect my posts to become as popular as the YouTube video United Breaks Guitars. And even more importantly, as fellow blogger Anirban Dutta writes, the song's social media campaigned moved an airline giant to action.

 

Where do you spend your time?

Of course, when you're not sitting in front of your computer,  you might not be reading a blog. Personally, I spend much of my daily commute listening to podcasts. If you commute by train, maybe you can use the BMC Today iPhone App to catch up on BMC blogs, podcasts, news, and thought leadership white papers. Now you'll have more time to read this blog - and maybe leave a comment.

 

The postings in this blog are my own and don't necessarily represent BMC's opinion or position.
| More
0 Comments Permalink

I admit it. I like manuals. When I wonder about a feature on my car, I turn to my manual. But my second stop is a community forum.

 

Did you notice that my blog is part of the BMC Communities? Is that your first stop when you have questions about BMC products? I like to check out the Service Support community, to find out what questions people are asking.

 

One of my colleauges is exploring new formats for communication and created YouTube videos about possible uses for Twitter and ebooks in technical communication.

 

Where are you getting your information?

| More
0 Comments Permalink

Award-winning documentation

Posted by mmarques Nov 6, 2009

- By Michele Marques, Lead Information Developer, ITSM

 

It's that time of year, when local chapters of the Society for Technical Communication (STC) hold competitions. Every year, local chapters hold competitions for print and online documentation. Then, the best of the local entries move on to the society-level international competition.
In 2007 I entered the BMC Remedy IT Service Management Data Management Administrator's Guide in the Toronto chapter competition. This guide describes how to install and use the data management tool for BMC Remedy IT Service Management.

 

I entered the competition because:

  • This was a new manual - everything good (or bad) about this manual was my responsibility. Many times, I work on manuals that have other contributors - or that originated with previous authors.
  • I wanted to find out how my documentation held up to international standards.
  • I wanted to get feedback from technical writers outside my organization.

 

I ended up winning a merit award. It felt great to get award and feel validated for my work. But the feedback was especially helpful. People from outside my organization had a different take on what works and what could be improved. Today the guide is better than ever.

 

I'm fortunate to work with a team of writers and editors, but for a lone writer, the competition might be your best opportunity to get feedback from experienced technical communicators.

 

The postings in this blog are my own and don't necessarily represent BMC's opinion or position.

| More
0 Comments Permalink

Conference round-up

Posted by mmarques Oct 30, 2009

- By Michele Marques, Lead Information Developer, ITSM

 

Wow, what a week for conferences! Yesterday I dropped by the BMC virtual conference, and earlier this week I attended Lavacon.

 

BMC Virtual Conference: Simplify & Automate IT

The BMC virtual conference was a really cool way to check out information on a variety of IT topics without leaving my desk. I watched the presentation on The Future of IT Management. Then I dropped by the Dell booth in the exhibit hall, to see what they had to say about their experiences with BMC Remedy IT Service Management.

 

I didn't get into any conversations, but I scrolled through the conversations in the networking lounge and in some of the exhibit booths. People were talking about BMC products and everyone was excited about the virtual conference.

 

Although the conference took place on October 29, you can still drop by. You can view any of the presentations on demand, pick up literature from the exhibit hall, and see what people were talking about

 

Lavacon

Lavacon is a professional development conference for senior, lead, and management technical communicators - and for the past few years has been paired with a regional Project Management Institute conference. It's a great conference that includes sessions and workshops that I wouldn't get at other technical communications conferences.

 

Sessions that I attended included:

  • Introduction to Strategic Planning by Alexandra Piacenza - There's only so much that she could cover in this brief session. Planning for innovation was especially interesting.
  • Creativity session and Leadership workshop by Lisa DiTullio - Interesting ideas about promoting creativity. Lots of discussion about the difference between Management and Leadership.
  • Zen and the Art of Managing Up by Emma Hamer - How many times do you run around in a tizzy, because your boss has an urgent request for information, and you have to figure out how to get the information? Emma had some great suggestions for ways to be proactive that can prevent these sort of disruptions.
  • Strategies for Coping with User-Generated Content by Sarah O'Keefe - Sarah opened with the video United Breaks Guitars as the ultimate in user-generated content that a company wouldn't want and then moved on to talk about strategies to involve users in a positive way in your community.
  • Influencing without Authority by Andrea Ames - Andrea has achieved a high level of influence that extends beyond technical communication.
  • Critical Thinking Skills for Conflict Resolution by Bonni Graham - We played a conflict role-playing game that helped show how personal biases and personal goals affect how people act in conflict. I'm not sure yet whether this knowledge will help me deal with conflict. I was really bad at picking up on people's hidden agendas.
  • Management Challenges with DITA by Jim Smith and Vivian Aschwandan - Whether you're a manager or a writer, some of the biggest challenges with DITA are knowing "what is a topic" and dealing with what they called "stealth topics" (such as tasks hidden in concepts).
  • DITA 1.2 and the DITA Open Toolkit by Robert Andersonand Leigh White - Although this workshop was fraught with hardware challenges, I'm now eagerly awaiting some of the new features of DITA 1.2, especially the conref extensions.

 

The postings in this blog are my own and don't necessarily represent BMC's opinion or position.
| More
0 Comments Permalink

- By Michele Marques, Lead Information Developer, ITSM

 

I'm writing this post from Lavacon in New Orleans.It's a really great conference, but this year's conference attendance is significantly lower than 2 years ago. It's no secret that conferences are having lots of problems getting enough participants this year. Since last year's economic meltdown, travel to conferences has been cut from many corporate budgets.

 

Some conferences offer virtual options. For example, the STC recorded all the sessions from their 2009 conference, and you can buy virtual attendance. You won't get to ask questions.... but you can attend all the sessions, and it doesn't matter if they were concurrent.

 

BMC is hosting a virtual conference.This conference is a live event, which means that you can ask questions and mingle with other participants. But, because it's virtual, you don't have to travel.

 

The postings in this blog are my own and don't necessarily represent BMC's opinion or position.
| More
0 Comments Permalink

- By Michele Marques, Lead Information Developer, ITSM

 

I'm looking forward to BMC Virtual Conference: Simplify & Automate IT on October 29. Because I spend much of my time documenting BMC Remedy IT Service Management, I'm looking forward to find out how Dell as been using BMC Remedy ITSM. I hope to also check out "From Hype to ROI: Getting Value from Virtualization, the Cloud and Automation" as it's such a hot topic.

 

Check out the list of sessions and virtual booths at  http://www.bmc.com/simplifyit and let me know which are your hot topics.

 

Hope to "see" you there! With no travel costs and no conference costs, it's easy to justify.

 

The postings in this blog are my own and don't necessarily represent BMC's opinion or position.
| More
0 Comments Permalink

- By Michele Marques, Lead Information Developer, ITSM

 

Some of you technical communicators have been working for years in XML and DITA. However, until recently, I wrote all of my product documentation in Adobe FrameMaker. Sure, you can write XML documents in FrameMaker. But I had been using "unstructured" mode, which doesn't enforce structure.

 

I just wrote a doc for an upcoming release using an XML editor and the DITA DTD. I was nervous starting out - after all, I've been using the same tools for years, and XML involves a new paradigm. But I also knew that this was a great time for me to move ahead in the new direction. I was about to reorganize the manual that I was working on.

 

Some things are easier in an XML authoring environment

Have you ever tried to reorganize a manual? Cutting and pasting between chapters isn't pretty - especially if you end up changing the hierarchy.

 

In XML, all my topics were separate files. All I had to do was edit (or create)  component and book maps. DITA uses component maps and book maps to determine the sequence and hierarchy of topics. Did I mention sequence and hierarchy? Each of the topics is a separate object in the component map; I can move the object up, down, left, and right. Within the topic, I have a title, and maybe one or more headings. The headings are relative to the topic title. But the overall hierarchy (which titles are chapter titles, which are heading1, which are heading2, and so on) is determined by the topic's placement in the hierarchy.

 

Actually, the titles aren't really chapter titles, heading1, and heading2 - that's a relic of paragraph styles from unstructured FrameMaker or Microsoft Word. Transforms give the visual appearance in the output (such as a PDF) that mark chapter titles and help readers differentiate between heading levels in the hierarchy.

 

But, enough of the technical digression. The point is that it was really easy to reorganize this material in the XML authoring environment!  If I had still been working in unstructured FrameMaker, I would be cutting and pasting.... and changing paragraph styles for the headings. And, somewhere along the line, I'd probably make a mistake or two, and maybe lose track of where I was in the hierarchy.

 

What about the pain?

OK, I didn't move into a fairytale when I started writing in XML. I'm new to this environment, so I'm still coming up to speed. As I learn the new tags and the new processes, I'm getting faster.

 

The most frustrating part was editing my index. I'm used to FrameMaker, where I have a tool (IXGEN) that will pull all of my index entries into one editable table - even sort them alphabetically. Then, I edit the entries in one place, and can push the changes back out to my FrameMaker files. And without this tool, I was able to generate an index, click with a special key combination on the index entry, and get to my index marker.

 

In the XML authoring environment, I can only see the generated index in my output (in this case, a PDF). I can see index entries as plain text within the XML topic files, but most of my index editing happens when I see the entire index together and realize that I need to modify some terms to be more consistent with others.

 

If any of you know about great tools for developing and editing index entries in XML topics, please let me know!

 

Was it worth the pain?

Yes! There are lots of benefits of working in small topic files. It's easier to reorganize material. And it's easier to divide parts of the document between writers. I'm looking forward to the next steps, when more people join me in this environment, and we can start sharing content.

 

The postings in this blog are my own and don't necessarily represent BMC's opinion or position.

| More
0 Comments Permalink

- By Michele Marques, Lead Information Developer, ITSM

 

Today I just read the news that BMC Software has been awarded the first official ITIL® software certification. How cool is that?

 

OK, if you're reading my blog because you're a technical communicator, maybe you're wondering why I'm so excited.

 

ITIL stands for IT Information Library®, and consists of a set of guidelines about good practices for IT departments. Used by thousands of organizations around the world, ITIL has become the de facto standard for IT best practices. I heard about ITIL before joining BMC, and since I joined have become ITIL Foundation certified (like most others).

 

When I first started working at BMC Software, I wrote documentation about BMC Remedy Service Desk. Even though I now write about other tools and products within BMC Remedy IT Service Management Suite, I'll always think fondly of BMC Remedy Service Desk.

 

What does all that have to do with the new certification? This ITIL certification is specifically: BMC Remedy Service Desk 7.0.3 Gold Level Process Compliance for Incident and Problem Management.

 

The postings in this blog are my own and don't necessarily represent BMC's opinion or position.
| More
0 Comments Permalink

- By Michele Marques, Lead Information Developer, ITSM

 

Have new technologies changes the needs for how software users receive information about the product? Do new technologies better enable us to meet user information needs? I've always provided information to users as manuals (print and PDF) and   as online help. But with new technologies (or improvements to old   technologies), we have more options:
  • Video - showing the product in use
  • Interactivity - using Flash or other technologies to add tutorial    elements
  • Wikis and discussion forums - enabling customers to collaborate and    share information
  • Proactive assistance - offering information for the current task,    without the need for the user to click a help link
  • New devices to display information, such as PDAs and mobile    phones

 

  • I'm sure that there are other cool ways to provide information to users. Do   you have any examples of other ways to provide information?

    Cool doesn't necessarily mean useful

    As our users spend more time on Web 2.0 sites and checking web sites on   their mobile phones, does this change the way that they need to receive   information when getting help on software products? Do people who've grown   up on YouTube read manuals or online   help topics?  If not, perhaps we information developers need to adapt   to the new paradigm.

    But to determine what's really useful, we have to look at what our users   need, whether in  manuals, help, or other product information. Where do they get stuck?   How do they process information? How will they find the information that   we're providing?

     

     

    The postings in this blog are my own and don't necessarily represent BMC's opinion or position.

    | More
    2 Comments Permalink

    Joining communities

    Posted by mmarques Apr 1, 2009

    - By Michele Marques, Lead Information Developer, ITSM

     

    In case you haven't noticed, there's an ever-increasing opportunity to join BMC communities. The BMC Developer Network (BMCDN) has been around for some time, but is now more social, with the ability to "friend" people, and other changes. Our blogs have also been around for a while - but recently moved over to BMCDN.

     

    Today I was thrilled to see that you can now join the BMC Developer Network fan page on Facebook. I once asked Could facebook influence technical communications? At that time, I was thinking about Facebook as a platform (the look and feel have since changed). But maybe the real influence will be in providing an additional forum in which to reach out and connect with users.

     

    Where do you get your information? What are your communities?

     

    The postings in this blog are my own and don't necessarily represent BMC's opinion or position.

    | More
    0 Comments Permalink

    Welcome to my new blog home

    Posted by mmarques Mar 26, 2009

    -by Michele Marques, Lead Information Developer, BMC Remedy ITSM

     

    Hello! I'm glad that you found me at my new home on the BMC Developer Network (BMCDN). Write On is not just a stand-alone blog, it's now part of the BMCDN community. If you're a registered member of the BMCDN community, feel free to "friend" me.  This will make it easier for you to see what I'm writing.... but also means that I can easily find what you're writing. If you have a comment or question in one of the discussion  forums, I might reply in the forum - or be inspired to post a new blog entry on the topic.

     

    As part of the transition, all my blog posts from talk.bmc have been imported. However, because Alena, who is managing this blog space, imported them, you'll see her name in the normal space for the author, and my name as text in the blog entry. Unfortunately, comments could not be imported with the blog posts.

     

     

    The postings in this blog are my own and don't necessarily represent BMC's opinion or position.
    | More
    0 Comments Permalink
    - By Michele Marques, Lead Information Developer, ITSM

    For decades, I've been reading prophesies of the paperless office, but it never seemed to get any closer. The computer age just led to more and more printouts of electronic documents. Now it seems that the trends of ever-increasing paper are reversing.

    According to an article in The Economist, US paper use per office worker has been declining since 2001. Digital natives (people who have grown up with computers and the internet) are used to dealing with information online and don't feel the need to print as much.

     

    Yet another datapoint to confirm that we're ready to go green in IDD.

     

    When users (or IT staff) want to read only certain topics in the user guides, providing printed manuals is an even bigger waste. As a self-professed techie problem management analyst writes, [printed] software manuals are an absolute waste of paper, and do nothing but kill trees. He proposes customized documentation. However, before you get to the point of custom on-demand software manuals, you can use the search capabilities in help files and online PDFs to get to the information you need, without wading through a sea of paper.

     

    The postings in this blog are my own and don't necessarily represent BMC's opinion or position.
    | More
    0 Comments Permalink
    1 2 3 Previous Next