Category Archives: Meetings

Our July 2011 Meeting: “ePub: What, Why, and How?” with Scott Prentice

Scott Prentice, chapter webmeister, president of Leximation, and all-around FrameMaker guru, brought us up to date regarding the latest developments in electronic book publication standards. With the current proliferation of portable Internet devices, the savvy tech doc specialist may want to be aware of the issues involved in converting source documents to those that are readable, usable, and attractive on small screens.

The standard is “EPUB,” which Scott prefers to render as “ePub.” It is just another of many eBook formats, such as MOBI, DJVU, PDF, HTML, and TXT, that has evolved through time to meet user needs. ePub specifies the format and structure of the deliverable, much like a CHM, HLP, PDF, or HTML file does, and it requires both an application and a device to render the content for viewing. The underlying format is XHTML and CSS, with all components, such as content, images, and navigation, invoked from a single header file. Digital rights management (DRM) may also be included. The real wonder of it all is that content flows to fit the screen of the device on which it resides (to varying degrees of quality, as we will see later).

The ePub specification is maintained by the International Digital Publishing Forum (IDPF), and ePub 2.0 became an official standard in September 2007. (The original Open eBook standard of 1999 was actually developed for audio files and accessibility.) ePub 2.0.1 is the current stable build, and there is already a 3.0 draft. ePub comprises the following specifications:

Open Publication Structure (OPS): a standard for representing the content of electronic publications

Open Packaging Format (OPF): defines the structure and semantics as well as the mechanism by which OPS components are related

Open Container Format (OCF): (Seriously, Officer! the ePub was closed!) defines the mechanism by which all components of an electronic publication are packaged into a single deliverable (a ZIP archive)

So what are the many advantages, and why care?

The number of dedicated eBook readers is expected to exceed 11 million units by the end of this year, and the ePub format is supported by all readers and applications except the Kindle. A particular advantage of the format, in an age of vanishing trees, is that it is well suited to content that has limited life span — such as those 15-lb. programming manuals that are soooo last week. Rendered by a variety of conversion tools, ePub format works best for linear content, although reference material can use this approach as well.

It’s relatively cheap to provide instant gratification with this format. The user can search, add bookmarks, and annotations, and the content is very portable. But beware the downsides.

Tables more than a couple of columns wide can be disastrous on small screens. Links do not always work. Compliance with the standard varies highly, with no approach fully compliant. Indexes are not supported (although it is possible to create one as a page with links).

And as we noted earlier, renditions vary greatly (and can be truly extraordinary). Scott presented views of three different readers for the same content, and the differences were striking. As you will need tools (hand rendering is possible but not recommended), be sure to test drive a variety of applications to see which does the best job for your target devices. Scott presented an example of a specification document that he had converted, and it was very attractive and usable on both an iPhone and an iPad.

Enough for this overview. Now see the presentation summary that Scott provided and do your own exploration. Then head to the ePub for an ePint and let it all sink in.

Our March 2011 Meeting: Optimizing Your Portfolio, with Andrew Davis

Andrew Davis, formerly principal of Synergistech Communications and now a recruiter for Content Rules (formerly Oak Hill Corporation), provided valuable insights (both live and remotely) at our March 2011 meeting. A true champion of the candidate, he reads a lot of job descriptions and resumes, and made clear that a great portfolio (and approach) is your best chance of landing a job in technical communications in the current environment (which, perhaps surprisingly, is becoming more and more favorable to the job seeker).

You can’t just have a resume anymore; you need hard evidence to back up what is on it:

  • Provide proof that you understand your audience, really know your tools, and can organize, write and deliver.
  • Have you mastered the three types of software documentation content (procedural, conceptual, reference)?
  • Have you mastered the three basic delivery types (linear prose, task-based help, instruction)?
  • Have you developed concrete doc plans?
  • Have you demonstrated a master of doc organization (TOC, concepts, procedures, reference, glossary, and even the index?)

Well, have you?

So what sells in the current market?

  • Clean, friendly prose with the end user clearly in mind
  • Illustrations, useful screen shots
  • Code examples
  • Complete instructions
  • Use cases and implementation scenarios
  • Troubleshooting

The audiences for each of the above are different, but the aspiring applicant who can demonstrate mastery of most of the above stands the best chance of success.

And when you are on the spot in front of your prospective employer, what wins?

  • An effective presentation, with information that is accessible, relevant, and in a meaningful context: what were the conditions, constraints, and strengths and weaknesses (yes, those) in how you succeeded — or not?
  • How did you approach similar challenges?
  • What did you deliver and why?
  • What did you learn?
  • How did you succeed in the end?
  • What was your role in development?
  • What were all the circumstances you encountered and how did you deal with them?
  • What would you do differently next time?

In short, be the best narrator you can, and leave nothing to chance.

So how does one deliver success stories these days? Many use the ubiquitous and affordable LinkedIn (which also hosts a “Creative Portfolio Display” section). Or develop a private website in which to hang your best work with a narrative. For the transfer of large files to your prospective employer, use box.net. Or use private directories (password protected, of course) and even (duh) email (for files that are not too large).

But, you say, all my examples are proprietary? Well, if you don’t deliver something, employers will assume you are bluffing if you just say, “Sorry, I have great stuff — just can’t show it.”

Too bad for you.

So how do you deal with the sticky issue of proprietary information? Here are Andrew’s suggestions, in increasing order of difficulty:

  • Ask the prospective employer to sign a nondisclosure agreement (NDA). Companies ask others to do that all the time, so don’t be shy. It shows you are a mature negotiator as well as a respector of (eventually their) intellectual property rights.
  • Neuter the content. Do search and replace on a variety of key words.
  • Redact key sections, as Acrobat Pro allows (Acrobat Standard may do this too). However, even though you can black out words and lines, be sure to lock the file against further edits!
  • Ask your ex (or currrent) boss for permission. Your judgment call here.
  • Contact your current (or previous) legal department for permission. Your judgment call here.
  • Ask for the names, addresses, and SSANs or the reviewing parties. Your judgment call here. (Success stories would be interesting to hear.)

In the absence of success in any of the above, or even if you have no current examples of the types of documents you would like to write, you can always take a public-domain document or public-domain information and rewrite and reorganize it, demonstrating your clear command of information management. Demonstrate your command of a technical subject area, as well as of your understanding of your audience.

Finally, avoid the classic “I am such a quick study, just teach me anything I need to know and I will learn it.” Well, that does not work in the current environment. No employer wants to hire a liability, and your inexperience should not end up their problem. Hiring managers are terrified to make a wrong hiring decision, and will instinctively minimize their risk any way they can.

So demonstrate the following with concrete examples: initiative, motivation, a master of subject matter sufficient for the task, an ability to overcome gaps in information and other challenges.  Most of all, make it crystal clear that you will be a good investment.

It is as simple as that.

For additional information, don’t hesitate to contact Andrew at andrewd@contentrules.com. Your success and his are intertwined.

January 22, 2011: Annual Berkeley Chapter Party and Touchstone Awards

Join us to relax with fellow communicators, enjoy a buffet dinner, and celebrate excellence in the profession.

Every year Touchstone, the Northern California Technical Communication Competition, receives many fine entries. We send the best ones to the STC International Summit Awards competitions. We will announce this year’s winners and display their entries throughout the evening.

During the evening we will also recognize and honor competition judges and Berkeley chapter volunteers for their contributions to the chapter and the profession.

Our yearly raffle: Wow, do we have some great items for our raffle this year! Thanks to the generosity and support from these wonderful vendors in our professional community:

* Adobe is providing a copy of Technical Communication Suite 3
* Author-it is providing a full user license to Author-it
* ComponentOne is providing a license for Doc-To-Help Enterprise
* MadCap Software is providing a copy of Flare V6
For menu and registration details, please go to http://www.stc-berkeley.org/MonthlyMeeting/january2011_annual_party/meeting_details.shtml.

Our October 2010 Meeting: Publishing PDFs from DITA

At our last meeting, Scott Prentice, chapter webmaster and president of Leximation, Inc., presented a concise summary of the motivations and issues involved in using the Darwin Information Typing Architecture to produce PDFs. Why use DITA at all? By using XML to author in a topic-oriented structure, DITA lets you rearrange topics and reuse them easily, depending on the deliverables (paper? PDA? online help?) you want from the same source material.

Isn’t this a wonderful thing? Yes, it can certainly be, depending on the nature and size of the enterprise and the amount and different types of content required–but it is not for everyone, and you had better choose your approach carefully from the start.

The great value that Scott provided in our online session was in detailing the various options. How much “manual” control to do you need (and have the technical resources to support)? How much built-in support do you need (and have the budget for)? What is the volume of your output and projection for future need, and how many “seats” do you need licenses for? These are just a few of the questions you must ask before heading down the DITA direction, because what looks like a simpler, more affordable approach at first could turn out to be an expensive, painful trap.

For a concise listing of the products, prices, and particulars of a variety of commercial DITA applications, you can’t do much better than review the brief summary of DITA issues that Scott has provided. Read it and be wise.

Our August 2010 Meeting: 101 Ways to Impress With Your Writing and Speaking

We in the technical documentation community are skilled writers and speakers. True. And we never need to revisit basic principles, and never ever get contentious over language. Not so true. This makes life fun.

At our August 2010 meeting, Arlene Miller, author of The Best Little Grammar Book Ever!, came with a short list of grammar questions, and not surprisingly there was a spirited discussion about the answers. Despite what we have learned in school and over the years, there is always room for analyzing the best way to say something — and sometimes for deciding whether to say it at all.

In keeping with the spirit of the evening, Arlene will be monitoring our new Grammar forum. Try this resource when you bump into a language challenge you would like to resolve, or just want to add expertise to the conversation.

Our July 2010 Meeting: A Tour of Virtual Worlds and How They Impact Technical Communicators

In this online-only event, Mike Ziegenhagen shared his growing expertise–and most of all his enthusiasm–ror the expanding sector of virtual world applications. Many are by now aware of Second Life, but Mike documented an application from Forterra Systems called OLIVE ™, an “online interactive virtual environment” that offers the security sorely lacking in the standard, free version of Second Life (OLIVE can be seen as “Second Life in business suit”). His experience with the team was also a great opportunity to work with both artists and actors, to achieve the best possible renderings and life-like actions of the avatars. Verisimilitude is more and more critical to success. Mike also gave a brief tour of Blue Mars, a 3D social networking application, based on high-definition game technology, that is definitely worth exploring.

There are additional applications for hosting secure virtual meetings: Venuegen can be “rented” for under $100/mo. for ten people or so, and 3DXplorer offers an enterprise beta version. Both are browser based. Also, Second Life Work offers an application-based approach for those willing to buy.

Why bother? It turns out that business are seeing the advantages to hosting so-called hybrid events and conferences. Participants who want to meet in meatspace continue to do so, while those distributed around the world appreciate the advantages of entering the virtual world. Indeed, perpetual virtual environments are turning out to be profit centers. Not only that, but they can be really fun (as long as you don’t get lost in layers of consciousness, Inception-style, so to speak. It is actually not all that hard to get lost. But fortune favors the brave and the curious. With increasing bandwidth and video processing power for less and less money, it it not inconceivable to see virtual meeting places become more and more common. They can be used to unite family members, and they provide unique opportunities for training. STC is rumored to have a group (more detail to be provided when it is available), and you can always check out NPR’s Science Friday Second Life.

Next steps?

  • Do some research.
  • Explore some sites.
  • Download Second Life viewer and take if for a ride.
  • Get a good headset.
  • Have some fun.
  • The NorthBay Chapter is looking forward to playing around with this new medium, so stay tuned and let us know if you want to test the virtual waters. It is almost as if the spirit of the early days of computing were back again.

    Our June 2010 Meeting: Creating a Knowledge Base using MadCap Flare and Madcap Feedback Server

    Wendy Bidwell had long planned to present at our chapter but was now in Florida.  Would she accept our offer to present remotely using Acrobat Connect? Indeed, she took the plunge and all went very well, becoming our first formal telepresenter.  The commute and parking were much easier, despite the late hours for her.

    Her theme: How to use MadCap Flare in conjunction with MadCap Feedback Server to manage data in association with an online help project–improving communication among writers, customers, and employees.  So-called “out-of-the-box” applications just weren’t doing it, but Flare provided a great way to manage a knowledge base, while making it easy to export content to a variety of target output formats. Combining MadCap Flare with a Feedback Server to create a company knowledge base provides improved, interactive communication among writers, customers, and employees.

    Users can add comments and rate topics, and writers can analyze user searches. This provides the same kind of valuable information one would have to obtain from talking to customers and support personnel and conducting usability studies.

    For detailed instructions on installing and configuring MadCap Flare and MadCap Feedback Server in this context, see Wendy’s document. Other servers are also supported.

    Meeting: Spring Networking Social at Maguire’s Pub in Petaluma

    A good time was had by all at our spring networking social at Maguire’s on May 20. We had a good turnout, and discussed all sort of interesting topics. The officers discussed some of the proposed changes to the chapter website as well as the new meeting style, which will be a mix of virtual and in-person meetings to encourage attendance by those people too far away to attend in person. Monique and I spoke about our experiences at the STC Summit, and Linda won the drawing for the free license of DITA-FMx (for enhanced DITA authoring in FrameMaker).

    I hope to see everyone at the next social!