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

f.lux 42.1 - Adjusts the color of your d...
f.lux makes the color of your computer's display adapt to the time of day, warm at night and like sunlight during the day. Ever notice how people texting at night have that eerie blue glow? Or wake... Read more
Spotify 1.1.94.872 - Stream music, creat...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue puts... Read more
Vitamin-R 4.15 - Personal productivity t...
Vitamin-R creates the optimal conditions for your brain to work at its best by structuring your work into short bursts of distraction-free, highly focused activity alternating with opportunities for... Read more
OfficeTime 2.0.628 - Easy time and expen...
OfficeTime is time and expense tracking that is easy, elegant and focused. Other time keepers are clumsy or oversimplified. OfficeTime balances features and ease of use, allowing you to easily track... Read more
Slack 4.28.182 - Collaborative communica...
Slack brings team communication and collaboration into one place so you can get more work done, whether you belong to a large enterprise or a small business. Check off your to-do list and move your... Read more
DEVONthink Pro 3.8.6 - Knowledge base, i...
DEVONthink is DEVONtechnologies' document and information management solution. It supports a large variety of file formats and stores them in a database enhanced by artificial intelligence (AI). Many... Read more
FileMaker Pro 19.5.4 - 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
Backblaze 8.5.0.628 - Online backup serv...
Backblaze is an online backup service designed from the ground-up for the Mac. With unlimited storage available for $6 per month, as well as a free 15-day trial, peace of mind is within reach with... Read more
Day One 7.16 - Maintain a daily journal.
Day One is an easy, great-looking way to use a journal / diary / text-logging application. Day One is well designed and extremely focused to encourage you to write more through quick Menu Bar entry,... Read more
Garmin Express 7.14.0.0 - Manage your Ga...
Garmin Express is your essential tool for managing your Garmin devices. Update maps, golf courses and device software. You can even register your device. Update maps Update software Register your... Read more

Latest Forum Discussions

See All

We’re Digging ‘Shovel Knight Dig’ – The...
We spend the bulk of this week’s podcast talking about the new iPhone 14. Specifically, the iPhone 14 Pro Max which both Eli and myself picked up. The consensus seems to be: They’re great! They’re iPhones! We do lay down our hot takes on all the new... | Read more »
TouchArcade Game of the Week: ‘Loose Noz...
There aren’t a lot of stories like that of the development of Loose Nozzles, and of those games that do have an interesting development story, even fewer are actually decent games to play. Loose Nozzles nails both, though. The way it was created is... | Read more »
SwitchArcade Round-Up: ‘Shovel Knight Di...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for September 23rd, 2022. In today’s article, we’ve got the rest of this week’s releases to look at. There are actually a few big games today, including the hot-hot-hot Shovel Knight Dig... | Read more »
‘Gubbins’ is a Way Too Adorable Word Gam...
There are games whose art style, sounds, and overall vibe just make me smile ear to ear. Games like Hidden Folks, Krispee Street, or Tiny Wings. There’s just something so cool about being able to literally feel the heart that goes into a game. Now... | Read more »
Based on the Baking Reality Show, ‘Naile...
Fans of Netflix’s reality baking show Nailed It! have a new holiday-themed season to look forward to next month when Nailed It! Halloween launches on October 5th, but the fun doesn’t stop there because the show is also arriving as a mobile game the... | Read more »
Cookie Run: Kingdom announces collaborat...
In news sure to excite fans of biscuits or K-Pop music, the Korean sensations BTS have teamed up with Cookie Run: Kingdom for a series of events. After some warm-up episodes, the collaboration will culminate in a BTS in-game concert, so if anyone'... | Read more »
‘Shovel Knight Dig’ From Nitrome and Yac...
Shovel Knight Dig () from Nitrome and Yacht Club Games is this week’s new Apple Arcade release. It is definitely one of my favorite additions to the service ever, and a fantastic game overall. I played it a few hours ago when it started rolling out... | Read more »
SwitchArcade Round-Up: ‘Mario Strikers’...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for September 22nd, 2022. Hunh, lots of twos in the date today. Nifty. As those who read yesterday’s article may remember, I got a vaccine shot about twenty four hours ago and it is... | Read more »
Rogue-Like Platformer ‘Tallowmere 2’ Lau...
The original Tallowmere from developer Chris McFarland launched on mobile way back in 2015, and to be honest it did not leave a good first impression with me. For lack of a better term, it just seemed… janky, and right from the start the game sort... | Read more »
Alchemy Stars newest event launches and...
Alchemy Stars has introduced its latest event, entitled Farewell, My Wonderland, bringing with it new characters and a bevvy of rewards. The event will reportedly focus on the underlying message that even after tragic events there is still light,... | Read more »

Price Scanner via MacPrices.net

Use our exclusive Apple Price Trackers to fin...
Our Apple award-winning price trackers are the best place to look for the lowest prices and latest sales on all the latest Apple gear this season. Scan our price trackers for the latest information... Read more
New promo at Verizon: Get Apple Watch Series...
Purchase a new iPhone 14 at Verizon, and get an Apple Watch Series 8 for as low as $5 per month. $120 in promo credits for the Watch are spread over a 36 month term, reducing the price of the Watch... Read more
Visible drops prices on Apple iPhone 13 model...
Verizon’s low-cost wireless cell service, Visible has dropped prices on iPhone 13 models to new low prices starting at $599: – iPhone 13 Pro Max: starting at $980 + free $200 gift card – iPhone 13... Read more
Back in stock! 14″ MacBook Pros with Apple M1...
Amazon has restocked 14″ MacBook Pros M1 Pro CPUs for $400 off MSRP, starting at only $1599. Shipping is free. Be sure to make your purchase from Amazon rather than a third-party seller. Their prices... Read more
This is the final week to take advantage of A...
Apple’s Back to School promotion for 2022 ends on September 26, 2022. As part of this promotion, Apple will include a free $150 Apple Gift Card with the purchase of any MacBook Air, MacBook Pro, or... Read more
Mac Studio with M1 Max CPU back in stock toda...
Apple has the base standard-configuration Mac Studio available again in their Certified Refurbished section for $1799, and it’s in stock today. Each Mac Studio comes with Apple’s one-year warranty,... Read more
Apple MagSafe iPhone battery on sale for $84,...
Amazon has Apple’s MagSafe Battery on sale for $84 today. Shipping is free. That’s $15 off Apple’s MSRP, and it’s the lowest price for one of these MagSafe batteries among the Apple retailers we... Read more
24-inch M1-powered iMacs available today at A...
Apple has a full range of 24-inch M1 iMacs available today in their Certified Refurbished store. Models are available starting at only $1099 and range up to $260 off original MSRP. Each iMac is in... Read more
Verizon offers free Apple iPhone 14 models to...
Verizon is offering a $800-$1000 discounts on Apple’s new iPhone 14 models for new and existing customers with a qualified trade-in. Price of the iPhone 14 will be spread over 36 months of payments,... Read more
Gazelle drops prices on iPhone 13 models to a...
Gazelle has a full line of discounted, refurbished, unlocked Apple iPhone 13 models now available starting at $469. iPhones are offered in Fair, Good, and Excellent conditions, and multiple colors... Read more

Jobs Board

Physician Assistant, Primary Care, *Apple*...
Physician Assistant, Primary Care, Apple Valley (1.07FTE) + Job ID: 65766 + Department: AV Primary Care + City: Apple Valley, MN + Location: HP - Apple Read more
Operations Manager - Mac/ *Apple* Engineerin...
…Responsible for the day-to-day activities relating to the engineering of Apple Macs in a complex, multi-platform environment. Demonstrates strong leadership, Read more
Lead Developer - *Apple* tvOS - Rumble (Uni...
…earnings, and positive sentiment About the role: We are looking for a Lead Apple tvOS Developer to join our application engineering team to expand our video centric Read more
Systems Administrator - *Apple* Devices / J...
…Administration **Duties and Responsibilities** + Configure and maintain the client's Apple Device Management (ADM) solution. The current solution is JAMF supporting Read more
Sr Product Manager, *Apple* TV Platforms -...
…an experienced senior product manager to drive the strategy and requirements for our Apple TV devices, acting as the champion and owner of the holistic experience in Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.