BMC Communities Banner

Write On: Exploring New Directions in Technical Communications

9 Posts tagged with the technical_writing tag

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

 

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

When I work at a job that produces many pages of documentation, how can I reduce my environmental footprint?

At home, I've been trying to reduce my environmental footprint more and more. My town keeps adding more items to the recycling list and now they collect compostable materials. Although ready to say no to trash, I've reduced my garbage to a not-so-full garbage bag every two weeks. You're probably doing something similar. We switched our bulbs to compact florescent (CFL), and even switched from paper to cloth napkins.

 

I work as an information developer, and mostly I work on user and administrator guides. That means that I'm producing pages and pages of information. So, how do I reduce the number of pages being printed?

 

Reducing the amount of printed documentation sent to customers

 

Last fall, I asked: Are printed manuals a thing of the past? My iPod came with a small instructive brochure in the box, and the rest of the documentation was available online.

 

BMC Software customers can download software, instead of ordering a physical box. But customers have indicated that even when they get a physical kit, they don't need all the printed manuals. Now customers will get electronic copies of documentation, and will only get printed copies on request.

 

Working online instead of on paper

 

If you're not an information developer, you might think that all my work is always online. Of course, I do my writing on the computer. But reviews and proof reading used to take place in a mix of paper and online.

 

Now, almost all work is taking place online. We can do proof reading from the PDFs. I enable commenting in PDFs, so that editors and reviewers can add their comments even from Acrobat Reader. They don't have to print drafts of my guides. And as a bonus, it's easier for me to work from their online comments, because I don't have to decipher handwriting.

 

What are you doing?

 

What are you doing to reduce your environmental impact at work? I'd love to hear what else I could be doing.

 

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

How would technical communications look on the Facebook platform?

On   Palimpset, Sarah blogged that she has recently joined Facebook and mused whether Facebook could be used for technical support or other technical communications.

 

I started wondering what documentation might look like on Facebook or other social media. Currently, most documentation is the equivalent of Web 1.0 - printed manuals, PDFs, online help, and other forms that present useful information, but don't allow users to reorganize the information, to add to it, or to communicate. Communications with users are typically handled separately from documentation.

 

What might documentation look like on the Facebook platform or other social media (Web 2.0) platforms?

 

What is salient about Facebook for documentation?

 

On your Facebook profile, information is presented in modules. These modules are typically small, although some expand to fit the content. As a user, you can control which modules to display, as well as their location on the screen.

 

Facebook provides space for you or others to write ("the wall"). Additionally, many of the modules provide space to add comments. Notes can be used for longer, article-length pieces of information.

 

On a user's profile, Facebook lists some of the user's friends, along with a link to display all friends.

 

How are these features relevant to documentation?

 

Information modules aren't new to technical writing. They're a key aspect of Content Management Systems, and have really taken off with XML and DITA. If we are using Facebook as a model, these information modules, would mostly contain small chunks of information, although some would expand for the needed content.

 

The user would be able to control which types of modules to display, and where to locate them on the screen.

 

Users would be able to annotate the documentation. These might be comments added to individual topics. If this were help on a multi-user system, each screen would have a place for messages, which could be a forum for adding tips or asking questions.

 

Facebook is about people; the friends displayed are part of the user's social network. For documentation, instead of friends, a list of related topics would be listed. If the list were over six, six topics would be listed, with a link to the complete list of related topics.

 

Can you give an example of how this might work?

 

On Facebook, your profile is centered around you, the user. Everything is about you and your friends. For documentation, we must find another starting point. For example, if Facebook-like documentation were provided as a help system, the starting point could be the user's screen when clicking Help.

Information modules might be available to:

  • List all tasks that can be performed on the current screen (with links to more information about the tasks)
  • List all tasks that include the current screen.
  • Describe the purpose of key fields on the screen.
  • Provide keyboard shortcuts, or other sorts of accelerators.

 

Notes would be available to present concepts and procedures relevant to the current screen.

 

A list of related tasks would be available.

 

The user could writer on "the wall" to write notes to himself (or other users) about the current screen, and to pose questions that other users (or someone in Support) might answer.

 

Does this seem like too much information to fit on one screen?

 

Perhaps. But if the system is as configurable as the Facebook profiles, the user can remove any modules that he doesn't want to see. Also, he can arrange the modules in any order or column, so that the overall layout meets his needs.

 

What about other social media platforms?

 

What about them? What do you think documentation would be like if it used a platform based on Myspace, LinkedIn, or twitter? Does Facebook inspire you in a different way?

 

If you have your own vision, write it up in your blog, and leave me a   comment. I'll post a round-up of the entries.

 

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 still find paper instructions with my software and hardware products, but there are fewer manuals, and the manuals are getting smaller. What sort of documentation do you get with the iPod?

 

For many years I've heard the debate over whether to include printed manuals with the products. It seems like the move to PDF, online help, wikis, and blogs must finally be making a dent in how much we print, because one of the printer manufacturers is running a big ad compaign in an attempt to get people to print more.

 

What sort of documentation do you get with the iPod?

 

Recently, I finally got an iPod. Of course, as a writer, I find myself paying attention to how they provide documentation, and it gives me some ideas for documentation minimalism. Even with their simple design, Apple includes a small printed manual. More of a mini-brochure with just a few basics to get started.

 

You have to go online to get a more complete manual. But what a great idea! Besides not wasting paper on printing (I didn't print my copy), I have the latest version.

 

But even if you don't look at the manual, some of the less obvious features are displayed on the iPod where you need it. For example, a note in the Contact section provides instructions on how to load contacts if you don't synchronize with outlook. Or when I accidentally created an on-the-go play list, an additional on-the-go play list appeared and included a note explaining the feature.

 

What does this mean for documenting larger products?

 

The iPod is a simple consumer device. Although it's a great device, it supports only limited functionality (not that I necessarily want it to do more). Does the iPod's documentation offer any suggestions to how to improve the documentation experience for products that offer greater functionality, such as BMC Remedy Service Desk?

 

To me, it seems like there are a few lessons that can be learned:

  • In the box, include printed materials only to cover the bare minimum of what people need to know to get started. This highlights what is needed to get started, and doesn't overwhelm people with information that they need only later.
  • Make the bulk of the manuals available on-line (although electronic copy included with the product distribution media might also work).
  • Provide help where they need it. Does this mean context-sensitive help? Field-level help? Help panels embedded in the product at key points? I'm not sure.

 

What about you?

 

How do you like to receive your product information? Do you have any examples of what works for you? and what doesn't? Leave a comment - I'd love to read your thoughts.

 

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

Sometimes in the rush to learn new skills, we forget old skills.

Recently, I read on Mark Cuban's blog how he realized that he's forgotten how to write. He's been taking notes electronically and become proficient at it - then when he was stuck in a meeting trying to take pen to paper, he realized that his skills had degraded.

 

I don't think I'll forget how to put pen to paper. After a brief experiment with electronic note-taking, I returned to hand-written notes. His post makes me wonder, however, whether there are other skills I've forgotten, and whether they'll prove useful again. For example, when I first started using a computer to write, I had to insert all sorts of mark-up tags in the middle of my writing. There was no WYSIWIG capability on terminals, and my PC didn't even have a graphics card.

 

Now, of course, I can write and mark my text as bold or italic with the click of a button, and see the effects of my mark-up. Will I ever need to see tags as plain text again? It could be a useful skill to relearn for working with XML. What do you think?

 

Have you ever forgotten a skill and wanted to use it again?

 

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

Does anyone outside of information developers care what technology we're using?

When I'm writing a guide, white paper, or even a blog entry, does anyone care what technology I'm using? To a certain point, it's the content that matters, and not how it got there. But technology can affect how that information is presented. It's not just whether you're reading my content in a PDF, HTML pages, or a help system. For example, the right graphic tools can make it easier to create certain types of illustrations (such as flow diagrams) or to annotate my illustrations.

 

It can also make a difference to all the people who work with me in producing documentation. Although I might be the person doing the writing, there are many people who play a role: product managers requesting new documents, subject matter experts (developers and others) providing information and reviewing documents, editors, and translators.

 

At times I've had discussions with subject matter experts on whether I use Microsoft Word or Adobe FrameMaker to create documents. Experts who like to write want to be able to enter their changes directly to the document - and they all have Microsoft Word. FrameMaker, however, is often the tool of choice for technical writers.

 

Do writers still have these discussions when they create HTML or XML documents? After all, developers often have tools fo editing HTML and XML documents. And tools shouldn't matter as much if we don't use proprietary file formats.

 

And what about moving to a content management system? That can change workflows for everyone who touches the document.

 

If you're not an information developer or technical writer, do you care what tool I'm using?

 

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

Writers are concerned about documentation in an Agile environment. Here are my two cents.

More and more developers are moving to Agile. As a result, information developers and technical writers are struggling with the best approach to creating documentation in an Agile environment. We don't want to write too much too early, for fear we will have to rework the document, as features change in subsequent iterations.

 

Anne Gentle blogged   about creating a Documentation Plan in an Agile environment. Her approach is to keep the doc plan high-level, and not get into all the details. My approach is to include updates to the doc plan in the schedule.   I plan to work on the most solid features first, and update plans with each iteration.

 

One great suggestion from Melody Locke is to include documentation in the acceptance criteria. I like this suggestion regardless of the development methodology being used. If documentation is truly part of the product, the product isn't complete without appropriate and accurate documentation.

 

I'm still fairly new to agile. But I like getting feedback from customers early on. When we receive customer feedback in the early stages, it's easier to make adjustments. When I get feedback on the documentation, I have time to make the guides better serve the customer's information needs.

 

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 Blog

Posted by Alena Hitzemann Jul 23, 2007

- By Michele Marques, Lead Information Developer, ITSM

 

An introduction to Michele Marques and her Write On blog with talk.bmc.com.

 

Although I've been writing personal blogs for some time, I feel a little nervous with my first corporate blog here at talk.bmc. I probably don't know you, and you don't know me. I'm no longer used to speaking publicly. Although many years ago at the Schulich School of Business, I gave a presentation to 600 incoming MBA students.

 

As a technical writer, I've become accustomed to anonymity. Plenty of people read what I write (manuals, white papers, technical bulletins, and so on), but only a few people know those are my words.

 

In case you haven't already read my bio, let me introduce myself. I started with BMC a couple of years ago as a technical writer. I write about products in the BMC Remedy IT Service Management (BMC Remedy ITSM) suite and solutions using those applications.

 

Recently, I had the opportunity to meet some customers. I came away from that meeting surprised and energized. Surprised - because some of their challenges were different from my preconceptions. Energized - because I had ideas I wanted to bring to our documentation that might enhance the customer experience. Hopefully, your experience.

 

I'm glad to have this opportunity to blog at BMC, because this will give me a forum where I can talk about ideas and get feedback from: customers, people in environments similar to our customers, and to others who are facing similar challenges.

 

Are you a customer? Are you providing IT service? I'd love to hear from you, to learn more about your challenges and what information you're seeking.

 

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