Technical Communications: Small Steps to a Giant Leap…

by Tony Self Follow us on Twitter View our profile on LinkedIn
 
Neil Armstrong, the first person to walk on the Moon, was born just twenty-eight years after Charles Lindbergh, who was the first person to fly non-stop across the Atlantic Ocean. In just one human generation, technology had progressed from fabric covered craft (with a speed of 130 mph and a range of 4,000 miles) to a liquid oxygen powered rocket ship that traveled at speeds of up to 25,000 mph (on a trip that covered 500,000 miles).

Technological change is not new, but the pace of change in some fields is breathtaking. Battery technology is one example, and photo-voltaics is another. And of course, technology associated with reading is experiencing a dramatic rate of change.

How do people cope with rapid change in their fields? Neil Armstrong learned to fly in 1945… a time when the sound barrier was considered to be an impenetrable barrier. By the time of Armstrong's first posting as a US Navy pilot in 1950, the sound barrier had been broken, and the first jet fighter squadrons had been formed. In 1957, Armstrong flew a rocket-powered aircraft for the first time. By 1960 he had flown at close to 4,000 mph (six times the speed of sound) to heights of 120,000 feet. Armstrong managed this transition as a pilot by continually learning. Over 10 years, he progressed from subsonic jets, to transonic jets, to supersonic jets, to rocket aircraft. Each step was relatively small, but overall it was a giant leap (to quote a phrase Armstrong later used when he stepped from Apollo 11).

How does Neil Armstrong's journey into space relate to technical communication? Consider that it only took 10 years for us to move from typewriters (1980) to laser printers (1990), from text-only Web browsers (1993) to websites with embedded movies (2003).

The Apollo 11 story can provide another lesson for technical communicators. As the name implies, Armstrong's Apollo 11 mission was the eleventh in a program of 20 missions. The program objective was landing a man on the Moon and returning him safely to the Earth. Each mission was part of a broad strategy… part of a far-sighted plan.

Big projects only reach their goals if they come with a comprehensive plan. Like many projects, there can be hurdles and disasters. The Apollo 1 spacecraft exploded on the launch pad, killing the three astronauts. The next three missions were unmanned flights to test systems. Each mission validated a different system. The unmanned Apollo 5 orbited the earth. Apollo 6 tested the Saturn V propulsion. Apollo 7 was a manned orbit. Apollo 8 circumnavigated the moon. Apollo 9 tested the lunar module, and 10 was a dress rehearsal. In documentation, this might be called iterative development. Unit testing is another IT term that might apply.

For large documentation or training projects, an Apollo approach is a good model. Here are some small steps to success:

  • Meticulously plan
  • Set achievable budgets and deadlines
  • Clearly state business goals
  • Develop a content strategy
  • Create prototypes and proof-of-concepts
  • Test and choose the right tools
  • Keep learning
  • Encourage your team
  • Continually check progress against the plan

and… most important…

  • Think big

Looking back, you'll see how those small steps became a giant leap.

Technical Communications: Online Versus Paper

by Tony Self Follow us on Twitter View our profile on LinkedIn

What is more effective, a print document or an online document? It wasn't all that long ago that print documents would definitely have been voted more effective, especially considering the poor quality of computer monitors and slow internet speeds. (Remember trying to pull up a document on a modem?)

Given the speed of today's internet and mobile device support, print documents are likely going the way of the dinosaur. Online documents have several advantages to their print counterparts. For instance, eBooks reflow to fit the user's device (think about how popular eBook readers such as the Amazon Kindle have become in just the past few years). Online documents are searchable, typically contain hyperlinks for easy navigation, often include videos and/or animations, and some even contain interactivity in the form of eLearning simulations created in Adobe Captivate or Articulate Storyline.

There are millions upon millions of print documents around the business world that would gain new life if they were online. The major challenge in moving from unstructured to structured documentation, or page layout to reflowing text, or paper to online, is the shift in mindset required. Simply put, many old design paradigms used for print documents don't fit in new media design.

There are many reasons for converting paper documents to online documents such as cost, efficiency of updating, document control, accessibility, and discoverability. Surprisingly, for the custodians of paper documents charged with managing the conversion, there is often a reluctance to embrace the migration from print to online. For those custodians, the paper version remains the primary document, and the online version is secondary. 

Even if the paper custodians agree to take the paper documents online, much time and effort is spent trying to imitate the paper design in the online design. For example, the paper documents are scanned and converted to PDF. While aPDF will work in an online world, a PDF is really just a digital replica of the paper document. While a PDF may open on a tablet or smartphone, it won't re-flow to fit the user's screen like an eBook.

If you're trying to convince the "powers that be" to make the move from print documentation to an online document, consider the following:

The text used in the print document may require a specific font and font size. When online content is displayed for the user, the user's device may have limited font capabilities. Even if the device is capable of displaying the font, if the user doesn't have that specific font installed on the device, the font displayed will be the browser's default. For instance, you have used Futura as the font for your content. If the user accesses your content via a web browser and does not have the Futura font on their computer, the browser will likely display Times New Roman instead.

Paragraphs may need to be indented by a specific amount. While setting up a specific indentation is easy in a print layout tool such as Adobe InDesign, the user's device may have limits to how indentations are displayed.

Headings may have to be sequentially numbered. While many print layout tools allow you to easily number paragraphs, those automatic numbers may not display properly online.

You may be required to include footnotes. While footnotes are easy to add to print documents, they're a problem online. Since there really isn't an end to a page online, where would the footnotes go?

Page numbers may no longer be valid. If your print document includes cross references (such as, "For more information, see page 11"), you could end up with a mess. If your print content is displayed as an eBook, the content that was on page 11 could now be located on page 22. If the text on the page tells the user to reference page 11, but the text is actually on page 22, you can imagine the trouble you'll have.

The graphics could be huge. In the print document, high resolution photos were used. They look great on paper. However, they're so big (in megabytes, not width or height), they'll take forever to download over the Internet if you leave them as-is. To use the images, you'll need to allow time to save the images as online versions (in jpeg or png format). When you do, the images will likely lose quality. Will they still look good?

If you do decide to migrate your print documents to the online world, off-the-shelf authoring tools such as Adobe RoboHelp and MadCap Flare will help make the process easy. Both tools allow you to quickly convert printed documentation (especially Word documents) into online documents. Both tools support cascading style sheets that handle fonts, colors, paragraph numbering, and indentation. And both tools allow you to create master pages complete with headers and footers. Nevertheless, there are limits to what any authoring tool can do when it comes to recreating the look and feel of a print document, so look into the limitations of each tool prior to moving forward. 

What's your take on print documents as compared to online documents? Is print doomed? Which medium do you think is more effective, print or online? What tool do you use to convert from print to online? Can you share instances/examples where you think print documents are more effective than online documents? Feel free to post your opinion as comments below.

Adobe Captivate: Record Simulations Using Smart Shapes Instead of Text Captions

by Kevin Siegel Follow us on Twitter View our profile on LinkedIn View our videos on YouTube
 
Text Captions have been available in Adobe Captivate since before Captivate was Captivate (think RoboDemo). While there's nothing terribly wrong with Text Captions, you're a bit limited when it comes to editing the way they look.

Take the Text Caption shown below for example. The arrow in the upper left of the caption is known as a callout.

Adobe Captivate: Standard Text Caption  

You can control a few attributes of the callout (you can use the Properties Inspector to select from a list of pre-determined positions and you can elect not to show the callout). But if you want to fully adjust the callout (perhaps move it a bit to the left or right, or make the callout a bit longer), you're out of luck.

Many Captivate developers, tired of the limitations of standard Text Captions, have forsaken Text Captions altogether for Smart Shapes. In the image below, I'm using a Rectangle Smart Shape. The shape looks much like a Standard Text Caption. I can control its appearance via Object Styles. However, check out how I am able to drag the shape's callout by dragging the yellow square. You can't do that with a Text Caption.

Adobe Captivate: The callout in a Smart Shape can easily be adjusted.

Because Text Captions are really bitmap images, I'm not able to fully control how the captions look unless I edit the bitmaps using an image editing program. With Smart Shapes, you can control just about every aspect of the way the shape looks by combining options found on the Properties Inspector with Object Styles.

While there is much to love about Smart Shapes, a perceived downside to Smart Shapes is that you can't use them to automatically get captions when recording a Software Simulation. You'll be happy to learn that you can, in fact, use Smart Shapes instead of Text Captions during the recording process.

Display Captivate's Preferences (Windows users, choose Edit > Preferences; Mac users, choose Adobe Captivate > Preferences). Choose a recording mode and, from the Captions area, select Use Smart Shapes instead of Captions.

 Adobe Captivate: Use Smart Shapes instead of Captions.

At that point, you'll be able to select the Smart Shape Type you'd like to use during the recording process.
 
Adobe Captivate: Smart Shape Type.
 
Click the OK button to close the Preferences dialog box and you're done. The next time you record a Software Simulation, the project will automatically contain Smart Shapes instead of Text Captions.

***

Looking for instructor-led training on Adobe Captivate? Check out our live, online, instructor-led Captivate classes.

Adobe FrameMaker: On-Demand QR Codes

by Kevin Siegel Follow us on Twitter View our profile on LinkedIn View our videos on YouTube

Unless you've been deliberately avoiding them, it's a good bet you've come across images similar to the one below.

QR Code leading to the IconLogic website. 
 
The image is known as a QR code. As you can see, QR codes are images that are made up of black and white squares. They are typically used for storing URLs or other information and can be scanned by QR Readers. In fact, if you have a smart phone, it may already have a QR Scanner. If so, scan the image above with the QR Reader and you'll be taken to the IconLogic website.
 
There's plenty of software you can find on the Internet that will allow you to create your own QR codes (some are free; some will cost you a few bucks). However, if you own Adobe FrameMaker 12, you have that ability to create QR Codes right now.
  1. Open or create a FrameMaker document and click where you want the QR code.
  2. Choose Special > Generate QR Code to open the QR Code Builder.
  3. In the File Name field, give the QR code a name (it will be saved as a PNG image) and specify a storage location.
    Adobe FrameMaker: Naming a QR Code.
  4. From the Type drop-down menu, select the type of QR Code you'd like to create (you can select from SMS, URL, Phone, Email, and Text).
    Adobe FrameMaker: QR Code type
  5. In the image below, I selected URL from the Type drop-down menu and then typed the IconLogic website URL.
    Adobe FrameMaker: URL QR Code.
  6. The final step is to set the size of the URL from the Size drop-down menu. (You can select a size from the Image Dimensions drop-down menu or type your own value into the Image Dimensions field.)
    Adobe FrameMaker: QR Codes
  7. Click the Insert button to insert the QR Code into the FrameMaker document.
And that's that. If you only wanted to use the QR Code in your FrameMaker document, you're done. However, if you want to use the QR Code in a different program, or include it in a newsletter like I did above, you'll find the QR Code image file in the folder you specified when you named the image (see step 3 above).

 

***

Looking for instructor-led training on Adobe FrameMaker? Check out our live, online, instructor-led FrameMaker classes.

Adobe Captivate 8: More is More

by Kevin Siegel Follow us on Twitter View our profile on LinkedIn View our videos on YouTube

Last week I told you about the great enhancements you'll see in Adobe Captivate 8 when it comes to image buttons. This week, I'm going to show you a few more improvements that I think you'll love.

Sample Projects/Tutorials
 
The first thing you'll see when you start Captivate is the Welcome screen. From this position, you can create a new project, record a software simulation/demonstration, or access recent projects. But take a look in the upper right of the Welcome screen and you'll see an awesome addition: Sample Projects/Tutorials (shown below, it's located in the upper right of the Welcome screen).
 
Adobe Captivate: Sample Projects/Tutorials
 
Granted, the icon to access the projects and tutorials is easy to miss; but once clicked, a dialog box opens and you'll have access to some really nice sample projects. The sample projects are shown first, followed by several tutorials.
 
Adobe Captivate: Sample projects and tutorials 
 
If you have already opened or created a project, you will find a Sample Projects/Tutorials icon via the top of the Captivate window (to the right of the Help menu).
 
Adobe Captivate: Sample Projects/Tutorials
 
However, clicking the icon from here is different than clicking it on the Welcome screen. If you click the icon while in a project, you'll be taken online to Adobe KnowHow, where you'll find some free and pay-for-access training videos.
 
Characters and Agents
 
I love the Characters feature added to Captivate a few years ago, which allows you to insert images/guides within a project. And I was delighted to see that not only did Adobe keep Characters in Captivate 8, they've added quite a few. To add a Character, choose Media > Characters. Select a Category, select a character, and then double-click a pose to insert the character onto a slide.
   
Adobe Captivate: More characters
 
Lastly, check out the Speech Agents (via Audio > Speech Management). Previous versions of Captivate included five Text to Speech Agents. You'll be happy to see that Captivate 8 bumps that number up to seven. New to the team are James and Yumi. I was particularly impressed with how good James sounded… a nice upgrade from Paul (sorry Paul). And Yumi covers you if you need audio for Korean eLearners.
 
Adobe Captivate: More Agents  
 
***
Looking for instructor-led training on the top eLearning tools? We offer live, online training on Adobe Captivate, Articulate Storyline, Adobe Presenter, and TechSmith Camtasia Studio. We can also bring the same great training onsite to your facility. Interested? Contact us for details.

Adobe RoboHelp: Show Variables in Topics

by Willam Van Weelden Follow us on Twitter View our profile on LinkedIn

In previous articles you've learned about RoboHelp's User Defined Variables (how to create themgroup them, and use them in topic titles).

As a brief review, variables can contain information that occurs frequently in your project, such as a product name, company name, or copyright notice. After creating the variable, you can insert it into any RoboHelp topic or onto a template by simply dragging and dropping. Now here's the cool part. Assume your company name now appears throughout your project and now you want to change it. Without the variable, you would have to search your entire project and update the company name. Thanks to variables, all you will need to do is update the definition of the CompanyName variable, and you will change the displayed company name project-wide in just a few seconds.

One issue you'll come across when inserting variables within a topic is that, by default, the variable text looks like regular topic text. In the picture below, I challenge you to locate the variable. 

Adobe RoboHelp: Find the variable text  

Did you find the variable text? I'm betting that the answer is no. So what's the big deal? This can be particularly frustrating if you need to replace regular text with a variable. For example, you can highlight regular text in a topic and convert it to a variable by dragging the variable on top of the text. That's an awesome feature. Before I begin however, I need to be able to tell, at a glance, if the text I'm looking to replace is already a variable. As it stands, I have no idea since I cannot tell the difference between a variable and regular text.

Luckily, RoboHelp has a handy feature that allows you to distinguish between variables and regular text in topics. To enable this feature, simply choose View > Show > Fields.

Adobe RoboHelp: Color coding for Variable Text. 

Voila. All variables in topics are now shown as green text. Best of all, variables only show up green in your project… when you generate a layout, the green color will not be visible to your users.

***

Looking for instructor-led training on RoboHelp? We offer live, online training once each month. We can also bring the same great training onsite to your facility. Interested? Contact us for details.

Adobe Captivate 8: Responsive Projects for mLearning

by Kevin Siegel Follow us on Twitter View our profile on LinkedIn View our videos on YouTube

Creating eLearning for mobile devices was high on the wish list a few years ago when Adobe asked users for the top features they'd like to see added to Adobe Captivate. It wasn't long before Adobe responded by adding HTML5 as a publishing option. HTML5 allowed developers to create interactive content that can be used by mobile learners who have a device that does not support Flash.

Publishing HTML5 solved the issue of creating interactive eLearning on the iPad. But there remained another problem. The size of the screen that learners use can vary widely. Your eLearning lesson might look perfect on a desktop system but might be too small when viewed on a small device (such as a smart phone). To accommodate the many screen sizes, your only recourse was to develop several Captivate projects, sized specifically to work on each screen size. Of course that also meant that you'd have to edit and update several projects. No thanks!
 
Adobe Captivate 8 now allows you to create responsive projects. During the development process, you can basically create and work on multiple screen sizes (called break points) in one project. When you publish the responsive project, the learner will automatically be served the break point appropriate for the device they're using. This one Captivate 8 feature is the main, compelling reason that upgrading to Captivate 8 isn't just something to consider… it's mandatory if your mission is to create eLearning for desktop and mobile users.
 
To create a responsive project, double-click Responsive Project on the Welcome screen or choose File > New > Responsive Project.
 
Adobe Captivate: Responsive Projects
 
Developing a responsive project is pretty much the same as developing a standard project, but there's one notable difference–breakpoints. By default, new projects contain three breakpoints for the most common screen sizes (for desktop users, tablet users, and smart phone users). You can click each of the breakpoints to see how the layout changes dependent upon the size of the canvas.
Adobe Captivate: Default breakpoints 
 
In the images below, I've selected each of the default break points I was given in my new project (you can create as many break points as you need and edit existing break points at any time).
Adobe Captivate: Breakpoint for a desktop user.
 

Adobe Captivate: Breakpoint for a tablet user.

Adobe Captivate: Layout for a smart phone 

In the images below, you can see a responsive project developed by Anita Horsley, and how she designed each canvas to work best with each of her break points. (As you review each image, pay particular attention to the position of the character as each break point is selected.)

Adobe Captivate: Breakpoint for a desktop user.
Desktop user: 1024 pixels wide.

Tablet user: 768 pixels wide.

Mobile user: 360 pixels

Once you're done laying out each canvas, all you need to do is publish and post the lesson to a web server or LMS just like always. When the lesson is accessed by your learner, the lesson will automatically detect the learner's screen size and the correct canvas will be displayed. Awesome!

***

Want to learn more about creating responsive projects? Join our3-hour mini course on creating Responsive Layouts with Adobe Captivate.
 
***
Looking for instructor-led training on the top eLearning tools? We offer live, online training on Adobe Captivate, Articulate Storyline, Adobe Presenter, and TechSmith Camtasia Studio. We can also bring the same great training onsite to your facility. Interested? Contact us for details.
 

Adobe Captivate 8: A Cleaner, Simpler User Interface

by Kevin Siegel Follow us on Twitter View our profile on LinkedIn View our videos on YouTube

Adobe last week announced Adobe Captivate 8, a significant upgrade to one of the top eLearning development tools in the world.

Over the past few years I've repeatedly heard a couple of complaints about Captivate. First, it was perceived as difficult to use. There were so many panels, pods, and toolbars it didn't take too much effort for the Captivate workspace to get cluttered. Sure it was possible to create a custom workspace, but that didn't seem to matter. The fact that a panel could be accidentally moved from one part of the screen to another was causing all kinds of drama.

Another major complaint was Captivate's lack of support for mobile users. You could publish a Captivate lesson as HTML5, but the way a lesson looked when viewed on different screen sizes wasn't something a developer could control.

Captivate users will be happy to learn that both major pain points have been addressed with Captivate 8. Shown below is the Welcome screen you will see when you first start Captivate 8. There are two tabs, Recent and New. After selecting New, you'll find the usual suspects including Software Simulation, Video Demo, and From PowerPoint. You'll also see a brand new… and very awesome… option for creating Responsive Projects (something I'll cover in a future post).

 
Adobe Captivate 8: Welcome Screen

If you're a veteran Captivate user, you'll notice right away that in addition to the Welcome screen getting a nice redesign, there is no longer a check box in the lower left to permanently hide the Welcome screen. This may not seem like a big deal, but I can't tell you how many times I've heard from people using Captivate 7 and older who tell me that the Welcome screen is missing. It turns out that they've accidentally hidden the Welcome screen. And while it's easy to bring it back, I'm delighted to see that since it cannot be hidden that issue is gone.

 
You'll be happy to learn that projects created in Captivate 6 and 7 will open in Captivate 8, and those projects willautomatically be upgraded to version 8. However, once upgraded, Captivate 8 projects will not open in older versions of Captivate. Prior to upgrading, I suggest that you make backups of your legacy projects just in case you need to open them in the older versions of the software.
 
After creating a new project or opening an old one, your next discovery will be the clean Captivate 8 interface.
 
Adobe Captivate 8: New Interface
 
At the left is the familiar Filmstrip; in the middle is the stage (or slide… call it what you like). There's no Timeline, no Properties Inspector, no Library. There's no clutter at all.
 
Of course, the missing panels are critical to your success in Captivate so you'll need to be able to open them. Take a look at the bottom of the Captivate window and you'll see the wordTimeline. One quick click on the word and the Timeline opens at the bottom of the Captivate window.
 
Adobe Captivate 8: Timeline button
 
Look in the upper right of the Captivate window and you'll find buttons that will show or hide both the Library and Properties Inspector.
 
Adobe Captivate 8: Library and Properties Inspector buttons.
 
You'll notice that you can open the Library… you can open the Properties Inspector… but you can't open them both at the same time. And you cannot drag panels around your screen like you could in legacy versions of the software. If you're a workspaces junkie, you're also not going to like the fact that you cannot create workspaces. No kidding. Visit the Window menu and you'll find Workspace > Reset Classic, but that's it. There's no menu item for creating a new workspace. Okay, so losing the Workspace feature is a bummer. But if you're really missing this feature, I've got good news. Visit Captivate's Preferences (Edit menu for Windows users; Adobe Captivate menu for Mac users) and you'll find an option to Enable custom workspaces/panel undocking.
 
Adobe Captivate 8: Enable custom workspaces.
 
Turn that option on, restart Captivate 8, and you'll be able to both drag panels around your screen and create custom workspaces.

***

Looking for instructor-led training on the top eLearning tools? We offer live, online training on Adobe Captivate, Articulate Storyline, Adobe Presenter, and TechSmith Camtasia Studio.We can also bring the same great training onsite to your facility. Interested? Contact us for details.

eLearning: Creating Accessible Content

by Anita Horsley View our profile on LinkedIn Follow us on Twitter
 
While I don't have a disability, I have experience, both personally and professionally, with people who have physical and learning disabilities. I have assisted people with developmental disabilities, and I volunteer for a Therapeutic Horseback riding program that helps children with disabilities ride horses. 

When it comes to eLearning, I develop content for many government and education organizations where Section 508 Compliance is required. Section 508, the Rehabilitation Act of 1973, requires all Federal agencies to make electronic and information technology accessible to people with disabilities.

If you want to make your eLearning courses accessible for everyone, it's a good idea to think about people who are hearing, visually, and dexterity (motor skills) impaired. Additionally, it's important to consider the elderly population and people who speak English as a second language.

Assistive devices provide a way for people with disabilities to communicate and train using technology. People who are visually impaired or blind need devices such as:

  • Screen readers (Jaws, Window Eyes)
  • Screen magnification
  • Braille displays

People with hearing impairments need visual representation of auditory information such as:

  • Closed captions
  • Graphic displays

People who have mobility impairments may need:

  • Alternative keyboards
  • Keyboard shortcuts

Although creating accessible eLearning can feel like an additional task, the goal is to enhance your eLearning courses by ensuring that all learners can master the instructional material and meet the learning objectives. When learning is accessible to all types of learners, you are not only complying with regulations, but you are reaching a larger audience, upholding social responsibility, and increasing your effectiveness as an eLearning developer and instructor.

Note: This is the first in a series of articles covering accessible eLearning from Anita. Stay tuned for more! And if you'd like to take a 3-hour deep-dive into the best practices for creating accessible eLearning, check out Anita's live, online course