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.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

FileMaker Pro 19.4.2 - Quickly build cus...
FileMaker Pro is the tool you use to create a custom app. You also use FileMaker Pro to access your app on a computer. Start by importing data from a spreadsheet or using a built-in Starter app to... Read more
Adobe Illustrator 26.0.3 - Professional...
You can download Adobe Illustrator for Mac as a part of Creative Cloud for only $20.99/month. Adobe Illustrator for Mac is the vector graphics classics in the design industry. It is a digital... Read more
WhatRoute 2.4.9 - Geographically trace o...
WhatRoute is designed to find the names of all the routers an IP packet passes through on its way from your Mac to a destination host. It also measures the round-trip time from your Mac to the router... Read more
Notion 2.0.20 - A unified workspace for...
Notion is the unified workspace for modern teams. Notion Features: Integration with Slack Documents Wikis Tasks Release notes were unavailable when this listing was updated. Download Now]]> Read more
Monterey Cache Cleaner 17.0.2 - Clear ca...
Monterey Cache Cleaner is an award-winning general-purpose tool for macOS X. MCC makes system maintenance simple with an easy point-and-click interface to many macOS X functions. Novice and expert... Read more
Firetask Pro 4.6.8 - Innovative task man...
Firetask Pro represents the next generation of easy-to-use, project-oriented task management apps. By combining David Allen's powerful Getting Things Done (GTD®) approach with classical task... Read more
Smultron 13.0.4 - Easy-to-use, powerful...
Smultron 13 is the text editor for all of us. Smultron is powerful and confident without being complicated. Its elegance and simplicity helps everyone being creative and to write and edit all sorts... Read more
Box Sync 4.0.8057 - Online synchronizati...
Box Sync gives you a hard-drive in the Cloud for online storage. Note: You must first sign up to use Box. What if the files you need are on your laptop -- but you're on the road with your iPhone? No... Read more
Audio Hijack 3.8.10 - Record and enhance...
Audio Hijack (was Audio Hijack Pro) drastically changes the way you use audio on your computer, giving you the freedom to listen to audio when you want and how you want. Record and enhance any audio... Read more
Direct Mail 6.0.1 - Create and send grea...
Direct Mail is an easy-to-use, fully-featured email marketing app purpose-built for macOS. Create, send, and track great looking email campaigns that get results. Start your newsletter by selecting... Read more

Latest Forum Discussions

See All

Hopefully Not Jared’s Last Show – The To...
My suspicions from last week were correct, and after my two kids tested positive for Covid last week both my wife and I have now tested positive as well. It seems you just can’t escape this stuff lately. Thankfully the two little ones are pretty... | Read more »
TouchArcade Game of the Week: ‘Micro RPG...
I feel like idle games are one of those perfect fits for the mobile platform. Not that they replace more involved gaming experiences when you’re in the mood for that, but they do fit in alongside other types of games just fine as a “go to" when you... | Read more »
‘Phantom Blade: Executioners’ Closed Bet...
Phantom Blade: Executioners is holding a small-scale technical test that lets players get first dibs on the KungFuPunk action RPG. Offered to selected players only, S-Game’s first Closed Beta Test will provide players with limited edition in-game... | Read more »
New ‘Warhammer 40,000: Tacticus’ Video S...
Back in September Snowprint Studios, who you may know from their previous Legend of Solgard or Rivengard, announced that they’d partnered up with Games Workshop to put out a new tactical game in the Warhammer 40,000 universe titled Warhammer 40,000... | Read more »
SwitchArcade Round-Up: ‘Pokemon Legends:...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for January 28th, 2022. We’ve got a bunch of new releases to look at today, with a few big hitters, a few mid-level diversions, and a healthy supply of compost. Since it’s Friday, we... | Read more »
Phantom Blade: Executioners, S-Game...
S-Game has kicked off its first Closed Beta Test for Phantom Blade: Executioners, inviting a selected few to get first dibs on the upcoming KungFuPunk action RPG on mobile. The CBT officially begins this January 28th, and beta testers will receive... | Read more »
‘Infinite Galaxy’ First Anniversary: Cel...
Cultivating a new generation of valiant commanders across 240 countries worldwide, Infinite Galaxy has quenched players’ thirst to explore the vastness of space – and there are only more intergalactic adventures to embark on from here on out. Camel... | Read more »
War and Order: How to brave the cold in...
War and Order's 6th-anniversary celebrations are underway, and all in good time too - this season not only brings about fabulous festivities, but it also lets players experience the harsh winter in an entirely new way. [Read more] | Read more »
‘Hidden Folks+’ Is This Week’s New Apple...
The original Hidden Folks from Adriaan de Jongh is an excellent hidden objects game featuring hand drawn visuals. It is an absolute joy to play, and it has now released on Apple Arcade in the form of Hidden Folks+ () as an App Store great. If you’... | Read more »
Mini Metro’s First Big Update of 2022 Ad...
Last year saw great updates for Dinosaur Polo Club’s Mini Metro ($3.99) which is also available on Apple Arcade as an App Store Great. | Read more »

Price Scanner via MacPrices.net

Apple has clearance 2020 13″ MacBook Airs ava...
Apple has clearance, Certified Refurbished, 2020 13″ Intel-based MacBook Airs in stock today starting at only $719 and up to $370 off original MSRP. Each MacBook features a new outer case, comes with... Read more
The cheapest iPhones for sale today at Apple...
Apple has restocked Apple Certified Refurbished iPhone 8 models starting at only $359. Each refurbished iPhone comes with a fresh external case, standard Apple 1-year warranty, and free shipping.... Read more
14″ MacBook Pro with Apple M1 Max CPU now in...
Looking for a new 14″ MacBook Pro with an Apple M1 Max CPU? Stock is finally trickling into Apple resellers. B&H has Silver 14″ M1 Max MacBook Pros in stock today for $2899 including free 1-2 day... Read more
14″ MacBook Pros with Apple M1 Pro CPUs are i...
Amazon is reporting stock of 14″ MacBook Pros with M1 Pro CPUs today with a $50 discount. Shipping is free, and delivery is available by February 1st for most configurations. Be sure to make your... Read more
Apple has restocked 13″ M1 MacBook Pros for $...
Apple has restocked a full line of 13″ M1 MacBook Pros available Certified Refurbished, starting at only $1099 and up to $230 off original MSRP. These are the cheapest M1 MacBook Pros for sale today... Read more
Apple’s AirPods Max headphones are on sale fo...
Amazon has Silver, Blue, and Space Gray Apple AirPods Max headphones on sale today for $100 off MSRP. Shipping is free, and all models are in stock today. Their price is the lowest currently... Read more
Open a new line of service at Verizon and get...
Verizon is giving away 64GB Apple iPhone 12 minis or your choice of an iPhone 11 to customers who choose one of these phones and open a new line of service. Offer is available online only, and no... Read more
Open-box 13″ M1 MacBook Airs now available st...
QuickShip Electronics has open-box return 13″ M1 MacBook Airs in stock and on sale for $200-$400 off MSRP on their eBay store right now with free express delivery. According to QuickShip, “The item... Read more
Verizon’s 2022 iPad promo: $100-$310 off any...
Verizon has cellular-capable iPads on sale for $100-$310 off MSRP when purchased with an Unlimited service plan. Sale price is applied to your account monthly over a 24 or 30 month period, depending... Read more
Sunday Sale: Apple AirPods are on sale for up...
Amazon has Apple AirPods on sale for $10-$100 off MSRP today, depending on the model. All are in stock today with free delivery: – AirPods Max headphones (Blue): $449 $100 off MSRP – AirPods Max... Read more

Jobs Board

Registered Nurse (RN) Employee Health PSJH -...
…is calling for a Registered Nurse (RN) Employee Health PSJH to our location in Apple Valley, CA.** We are seeking a Registered Nurse (RN) Employee Health PSJH to be Read more
Systems Administrator - Pearson (United State...
…and troubleshoot Windows operating systems (workstation and server), laptop computers, Apple iPads, Chromebooks and printers** + **Administer and troubleshoot all Read more
IT Assistant Level 1- IT Desktop Support Anal...
…providing tier-1 or better IT help desk support in a large Windows and Apple environment * Experience using IT Service Desk Management Software * Knowledge of IT Read more
Human Resources Business Partner PSJH - Provi...
…**is calling a** **Human Resources Business Partner, PSJH** **to our location in Apple Valley, CA.** **Applicants that meet qualifications will receive a text with Read more
Manager Community Health Investment Programs...
…is calling a Manager Community Health Investment Programs PSJH to our location in Apple Valley, CA.** **Qualified candidates will be invited to do a self-paced video Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.