TweetFollow Us on Twitter

Guide Book Reviews
Volume Number:12
Issue Number:1
Column Tag:Book Review

New Apple Guide Authoring Aids

Three books and accompanying software for Apple Guide authoring

By John R Powers, III, guideWorks, LLC

Apple Guide Complete: Designing and Developing Onscreen Assistance
By Apple Computer, Inc.
Addison-Wesley (0-201-48334-3)

$39.95. 554 pages.

Real World Apple Guide
By Jesse Feiler
M&T Books (1-55851-429-5)
$39.95. 411 pages.

Danny Goodman’s Apple Guide
Starter Kit
By Danny Goodman and
Jeremy Joan Hewes
Addison-Wesley (0-201-48349-1)

$34.95. 295 pages.

Apple Guide authoring just got a lot easier. Three new books and accompanying software make it that way. If you already know about Apple Guide, skip to the next section. Otherwise, hang on and I’ll give you a quick introduction. [For more on Apple Guide, see the March and July ’95 MacTech Magazine.]

Introducing Apple Guide

Apple Guide is the exciting help system that comes with System 7.5. It enables users to accomplish tasks with minimal directions. It actively leads users through the steps required to complete desired tasks. For example, let’s pretend you make fax software. You may use Apple Guide to lead your user through the steps to send a fax, including how to set up the address, cover page, and scheduling transmission. You do this by creating a guide file that interacts with the user step-by-step. The guide file checks the user’s context and presents only the necessary information. It also automates many of the steps via AppleScript, and uses Apple Guide’s unique “coach marks” to highlight live interface elements so that users can simply point-and-click their way through the process. Your users are happier and your customer support line is less busy.

With the recent release of version 2.0, Apple Guide technology is available from System 7.0 on up; and it will be a key part of Active Assistance in Copland. More and more applications are including guide files. Third party developers like the way it gives them a competitive advantage and reduces the load on customer support. Major corporate users like how it streamlines the work flow and how it reduces the load on the help desk.

Authoring Apple Guide

One authors Apple Guide by combining content and instructions into a guide file. The current guide authoring tools are Guide Maker, Guide Composer, and Danny Goodman’s Apple Guide Starter Kit.

Guide Maker is the original Apple Guide authoring tool developed by Apple. It’s five tools in one: build guide files, test look-for, diagnose guides, convert WinHelp, and import/export for localization. Guide Maker uses Guide Script as its means for “programming” guide files. Guide Script is a mark-up language; the author writes the guide content and tags the content with Guide Script. There are about 100 commands that control startup parameters, formats, sorting, sequences, and much more.

Guide Composer and Danny Goodman’s Apple Guide Starter Kit (the latter included with his book, discussed in this article) are two new tools that provide a WYSIWYG interface to guide authoring. Both of them output Guide Script for automatic compilation by Guide Maker Lite, a special version of Guide Maker without a user interface.

New Authoring Aids

The new books and accompanying software are:

Apple Guide Complete: Designing and Developing Onscreen Assistance

This is Apple’s own Apple Guide book, written by Apple’s Developer Press. Think of it as the Apple Guide Inside Mac, 2nd Edition, for guide authors. It provides authoring tips and suggestions, describes how to use Guide Maker and Guide Script, and documents the Apple Guide API.

Apple Guide Complete includes a CD-ROM with lots of Apple Guide material, including Apple Guide, Guide Maker, sample guide files, sample source files, sample context checks, the Apple Guide interface files and libraries, and a searchable command reference to all Guide Script commands. The CD-ROM does not contain the latest release of Apple Guide (2.0), Guide Maker (1.2.7), or Guide Maker Lite (1.2.5); those you’ll have to get from Apple’s ftp site, Apple’s Developer CD, or the Mac OS SDK.

Real World Apple Guide

This book covers much of the same material as in Apple Guide Complete, but with an emphasis on actually using Apple Guide to solve problems. Think of it as Jesse’s Handy Guide to Using Apple Guide. It contains the prerequisite chapters on Apple Guide, Guide Maker, Guide Script, and the API, but also includes chapters on creating guide files for use with common frameworks and applications. For example, it describes how to add Apple Guide to MacApp and 4th Dimension.

An accompanying CD-ROM includes Apple Guide, Guide Maker, and related files. It also includes lots of demos, and a cookbook which comprises shells, guide script examples, and code examples. Like Apple Guide Complete, the CD-ROM does not contain the latest releases.

Danny Goodman’s Apple Guide Starter Kit

This book takes a completely different approach from the other two. Danny starts the reader immediately authoring guide files using his Starter Kit software. It’s a very “hands on” approach that quickly produces a guide file from Danny’s WYSIWYG interface. Once you learn how to use the authoring tool, Danny and his co-author, Jeremy Hewes, introduce design concepts and advanced topics.

The book includes a floppy disk with the Guide Starter software, Guide Maker Lite, a sample application, and support files. Apple Guide and Guide Maker are not included, nor are they necessary since Apple Guide is in System 7.5 and Guide Maker Lite is the only compiler Danny’s software needs.

Comparisons

We’ll attempt to help you sort out the possibilities by providing a couple of different ways to compare the books.

Who is the reader?

Third party developers use Apple Guide create guides for their applications. All three books cover this.

Solution providers use Apple Guide to develop custom guides for end users. While ways to do this can be inferred from any of the three books, only Real World Apple Guide includes specific information on creating guides for common third party applications and frameworks.

Application software engineers need information on how to support Apple Guide within their applications. Apple Guide Complete and Real World Apple Guide provide API documentation for this.

How well do they support the development process?

Creating Apple Guide files requires a seven-step process: task analysis, instructional and visual design, writing content, scripting, application integration, testing, and localization. Let’s examine how each book supports each step in the development process.

Task analysis: identifying and articulating the tasks that the user must accomplish. This is a very difficult step, but essential for Apple Guide’s task-oriented design. Conclusion: zip for all three. None of the books provide help in this essential area.

Instructional and visual design: specifying how the guide will support the user’s tasks. Conclusion: all three books provide good coverage of this area. Apple Guide Complete provides the most information on design.

Writing content: creating the words and images to support the instructional and visual design. Also includes all the indexing of the guide topics for the Apple Guide’s search engine. Conclusion: Apple Guide Complete and Danny Goodman’s book provide information on this area. Apple Guide Complete also covers the difficult area of indexing.

Scripting: wrapping the Guide Script around the content. This includes all the sequencing of steps, context checking, and automation. Conclusion: All three books provide ample coverage of this difficult step in the process. None of the books cover automation scripting using AppleScript, though.

Application integration: Apple Guide does not require that the application it supports be changed in any way, but if you can change it, you can really improve the user interaction. Application integration adds code to the application to support the guide. Conclusion: Apple Guide Complete and Real World Apple Guide provide reference material for application integration. Real World Apple Guide also provides detailed integration information for MacApp.

Testing: guide files must be tested like any other complex software. Conclusion: Apple Guide Complete provides a little information.

Localization: guide files, like the applications they support, must serve an international market. The guide content must be localized. Conclusion: Apple Guide Complete provides a little information.

What do I buy?

All three books are helpful for guide authoring. If you have to pick just one, consider the following: For a comprehensive reference, pick Apple Guide Complete. For custom solutions and practical applications, pick Real World Apple Guide. For a fast start, pick Danny Goodman’s Apple Guide Starter Kit.

 
AAPL
$104.83
Apple Inc.
+1.84
MSFT
$45.02
Microsoft Corpora
+0.64
GOOG
$543.98
Google Inc.
+11.27

MacTech Search:
Community Search:

Software Updates via MacUpdate

Delicious Library 3.3.2 - Import, browse...
Delicious Library allows you to import, browse, and share all your books, movies, music, and video games with Delicious Library. Run your very own library from your home or office using our... Read more
Art Text 2.4.8 - Create high quality hea...
Art Text is an OS X application for creating high quality textual graphics, headings, logos, icons, Web site elements, and buttons. Thanks to multi-layer support, creating complex graphics is no... Read more
Live Interior 3D Pro 2.9.6 - Powerful an...
Live Interior 3D Pro is a powerful yet very intuitive interior designing application. View Video Tutorials It has every feature of Live Interior 3D Standard, plus some exclusive ones: Create multi... Read more
The Hit List 1.1.7 - Advanced reminder a...
The Hit List manages the daily chaos of your modern life. It's easy to learn - it's as easy as making lists. And it's powerful enough to let you plan, then forget, then act when the time is right.... Read more
jAlbum Pro 12.2.4 - Organize your digita...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code!... Read more
jAlbum 12.2.4 - Create custom photo gall...
With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly, with pro results Simply drag and drop photos into groups, choose a design... Read more
ExpanDrive 4.1.7 - Access remote files o...
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
OmniOutliner Pro 4.1.3 - Pro version of...
OmniOutliner Pro is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It'... Read more
Evernote 5.6.2 - Create searchable notes...
Evernote allows you to easily capture information in any environment using whatever device or platform you find most convenient, and makes this information accessible and searchable at anytime, from... Read more
OmniOutliner 4.1.3 - Organize your ideas...
OmniOutliner is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It's... Read more

Latest Forum Discussions

See All

Toca Boo (Education)
Toca Boo 1.0.2 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0.2 (iTunes) Description: BOO! Did I scare you!? My name is Bonnie and my family loves to spook! Do you want to scare them back? Follow me and I'll... | Read more »
Intuon (Games)
Intuon 1.1 Device: iOS Universal Category: Games Price: $.99, Version: 1.1 (iTunes) Description: Join the battle with your intuition in a new hardcore game Intuon! How well do you trust your intuition? Can you find a needle in a... | Read more »
Ravenous Rampage (Games)
Ravenous Rampage 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: | Read more »
Partia 2 (Games)
Partia 2 1.0.1 Device: iOS Universal Category: Games Price: $5.99, Version: 1.0.1 (iTunes) Description: Partia 2 is a SRPG (Strategy Role-playing) video game inspired by Fire Emblem and Tear Ring Saga series. In a high fantasy... | Read more »
Puzzle to the Center of the Earth Review
Puzzle to the Center of the Earth Review By Campbell Bird on October 23rd, 2014 Our Rating: :: SPELUNKING PUZZLESUniversal App - Designed for iPhone and iPad Do some puzzles to make some platforms in this smart and fun free-to-play... | Read more »
Sleep Attack TD Review
Sleep Attack TD Review By Jennifer Allen on October 23rd, 2014 Our Rating: :: A TRUE TWISTUniversal App - Designed for iPhone and iPad Sleep Attack TD is a tower defense game with a difference – you can rotate the layout – and it’s... | Read more »
Mecanic (Education)
Mecanic 1.0 Device: iOS Universal Category: Education Price: $1.99, Version: 1.0 (iTunes) Description: Plates, screws, wheels ... Everything you need to achieve whatever you want... MECHANICWith 'MECANIC' kids will have fun... | Read more »
Earn Your Master Camper Badge in Camp Po...
Earn Your Master Camper Badge in Camp Pokemon Posted by Jessica Fisher on October 23rd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Garruk Gets His Revenge in a New Magic 2...
Garruk Gets His Revenge in a New Magic 2015 Expansion, Coming This November Posted by Jessica Fisher on October 23rd, 2014 [ permalink ] | Read more »
Sentinels of the Multiverse Review
Sentinels of the Multiverse Review By Rob Thomas on October 23rd, 2014 Our Rating: :: SENTINELS ASSEMBLEiPad Only App - Designed for the iPad Greater Than Games’ tabletop classic, Sentinels of the Multiverse swoops in to save the... | Read more »

Price Scanner via MacPrices.net

Save up to $125 on Retina MacBook Pros
B&H Photo has the new 2014 13″ and 15″ Retina MacBook Pros on sale for up to $125 off MSRP. Shipping is free, and B&H charges NY sales tax only. They’ll also include free copies of Parallels... Read more
Apple refurbished Time Capsules available sta...
The Apple Store has certified refurbished Time Capsules available for up to $60 off MSRP. Apple’s one-year warranty is included with each Time Capsule, and shipping is free: - 2TB Time Capsule: $255... Read more
Textilus New Word, Notes and PDF Processor fo...
Textilus is new word-crunching, notes, and PDF processor designed exclusively for the iPad. I haven’t had time to thoroughly check it out yet, but it looks great and early reviews are positive.... Read more
WD My Passport Pro Bus-Powered Thunderbolt RA...
WD’s My Passport Pro RAID solution is powered by an integrated Thunderbolt cable for true portability and speeds as high as 233 MB/s. HighlightsOverviewSpecifications Transfer, Back Up And Edit In... Read more
Save with Best Buy’s College Student Deals
Take an additional $50 off all MacBooks and iMacs at Best Buy Online with their College Students Deals Savings, valid through November 1st. Anyone with a valid .EDU email address can take advantage... Read more
iPad Air 2 & iPad mini 3 Best Tablets Yet...
The new iPads turned out to be pretty much everything I’d been hoping for and more than I’d expected.”More” particularly in terms of a drinking-from-a-firehose choice of models and configurations,... Read more
Drafts 4 Reinvents iOS Productivity App
N Richland Hills, Texas based Agile Tortoise has announced the release of Drafts 4 for iPhone and iPad. Drafts is a quick capture note taking app with flexible output actions. Drafts 4 scales from... Read more
AT&T accepting preorders for new iPads fo...
AT&T Wireless is accepting preorders for the new iPad Air 2 and iPad mini 3, cellular models, for $100 off MSRP with a 2-year service agreement: - 16GB iPad Air 2 WiFi + Cellular: $529.99 - 64GB... Read more
Apple offering refurbished Mac Pros for up to...
The Apple Store is offering Apple Certified Refurbished 2013 Mac Pros for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The... Read more
Select MacBook Airs $100 off MSRP, free shipp...
B&H Photo has 2014 a couple of MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only. They also include free copies of Parallels Desktop and LoJack for... Read more

Jobs Board

*Apple* Solutions Consultant - Apple Inc. (U...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.