Skip to Content

Free TUAW iPhone app -- try it now!
AOL Tech

documentation posts

Filed under: Developer

Xcode Tip: Updating your documentation

It appears that the Dev Center at Apple just updated its documentation set today. If you're using Xcode 3.2 and you want to update your documentation, you might be looking in the wrong place.

Before 3.2, you used to update your documentation in the Developer Documentation window (Help > Developer Documentation, or Command-Option-?). Now you'll find your documentation sets in the Xcode Preferences window (Xcode > Preferences... or Command-, and then choose the Documentation tab). Also, if checked, Xcode will automatically update your documentation when you launch it.

This Documentation panel offers subscription options for installing a documentation set (such as, for example, Mac OS X Legacy Library or iPhone OS 2.2 Library) as well as a handy Check and Install Now button that lets you request the latest updates. Use this to keep on top of the latest documentation updates.

Thanks, Scott Lawrence and @zadr

Filed under: iPhone, iPhone 101

iPhone for Newbies: Honey, I shrunk the manual



Caveat Emptor: This is for newbies only. If you've been around, you probably don't need this.


When I bought my last Verizon phone, it came with about three quarters of a pound of paper housed in three manuals allowing me to find just about anything through the index. Yeah, it was overkill -- but at least I knew where to go to learn about an option or feature.

When I opened my iPhone 3GS, I quickly searched for the documentation to show me how use this puppy. All I found was an accordion-pleated piece of paper, titled Finger Tips, telling me all the wonderful things my new iPhone could do... but it was awfully skimpy on covering just how to do anything at all.

On the last page of Finger Tips there were some links to get more information. Following the links would give you almost what you need. But I question how using a software-based paradigm of digital manual delivery relates to a hardware-based product like an iPhone 3GS.

Perhaps that's why an industry has sprung up to print instructional books. David Pogue's massive 'Missing Manual' series speaks to my point. If a good manual were to be included in a hardware product, 'Missing Manuals' would be superfluous.

Apple's manuals have been shrinking for many years; they have come a long way from that of the Apple ][+, in which Woz printed the entire ROM code of its 6502 processor.

The Apple way is to compactly package hardware. This seems way more elegant than being handed a big honking box. But adding half an inch to the height of the iPhone box, to accommodate a concise manual, wouldn't damage the minimalist look.

I don't feel quite right about having paid a goodly sum of money for the box and then having to download a 213-page manual using my own resources. My preference would be to have a manual the size of the iPhone 3GS right in the box, for immediate reference. With that, I could get started right away. After all, if you buy a new piece of technology, you don't want to be slowed down by needing to download and possibly print hundreds of pages along with reading a bunch of sites. You just want to push some buttons and play.

For those who have either lost the brochure or want some more information, see below for links where you can get it. Of course, you can always start with the "iPhone Help" section under the Help menu in iTunes.

The 213 page manual for the iPhone 3GS
Quickstart guides for various iPhone 3GS features
A video guided tour of major features of the iPhone 3GS

And here are some other resources to get you started:
Macworld's App Guide: Searchable by category
19 instructional books on how to manage your iPhone
Apptism - catalog and reviews of over 53,000 apps
Macworld's general listing of 3.0 features
TUAW's iPhone 101 series

I'm sure that many more resources are currently being written, but the links above are more than enough to get started.

I wonder how many agree with me that leaving out a decent manual is a poor idea, and how many of you consider this a non-event.

Do you miss having a paper manual in the iPhone 3GS box?

Filed under: Analysis / Opinion, Multimedia, Software, Odds and ends, iTunes, Apple, Developer

iTunes 8.2 to include Blu-ray support?


Update: Our bad... the date on the MacRumors comment was in late April, and this recycled up into our queue due to an editing mixup. Apologies –Ed.

There's a new iTunes beta version out in developers' hands straight from Apple, and a forum poster over at Mac Rumors found a little something fun in the About screen: a reference to Gracenote's ability to identify Blu-ray discs. Gracenote is the service that IDs your CDs when you import them into iTunes, so you don't have to sit there and type all the track names and artist information in. Apparently Apple is mentioning that not only CDs and DVDs, but also Blu-ray discs, will get information from Gracenote in the latest version of iTunes.

This doesn't mean that Apple will adapt Blu-ray as a standard (though it would probably be about time, don't you think?). But it should mean that the future version of iTunes will include Blu-ray support, so if you happen to have a Blu-ray drive hooked up to your Mac, you'll be able to read or play the discs via iTunes.

It could just mean that Apple has upgraded the Gracenote version in their app, however, and that they have no plans to actually use it -- the text in the About screen could just be a boilerplate cut-and-paste from some required Gracenote documentation that happens to include "Blu-ray." We'll have to wait and see just what shows up in 8.2 when it eventually releases to the public.

Filed under: Software, Productivity

ScreenSteps 2.5 takes screen-based documentation a step forward

ScreenSteps, the invaluable tool (mentioned here many a time) for writing software documentation quickly and easily, has updated to version 2.5. Among the new features is improved annotation capabilities, including a text tool and keyboard shortcuts for speedy duplication and repositioning of annotations.

You can set a status on lessons to remind yourself what's ready to publish, and what needs a little more work. Lesson steps can be more easily manipulated and reordered in the lesson inspector. Also, compiling lessons into full manuals is significantly easier, including the ability to quickly filter which lessons are included at the time of export.

I use ScreenSteps extensively in training clients on the websites I work on. It's not expected of me in most circumstances, but a PDF instruction booklet or an HTML export embedded in the content manager does wonders for reducing support calls. If you write any kind of screen-based documentation and haven't taken a look at ScreenSteps, it would be worth its price in the time it could save you. The best part of the system is that you can easily re-use and update manuals without much hassle, allowing a skeleton manual to be quickly turned into a custom manual for a client, or making it easy to add a step you didn't think of until you were in the middle of a training session.

You can try out ScreenSteps for free, and pick up one of two versions if you dig it: Pro for $59.95US, or Standard (lacking export of full manuals and support for MindTouch Deki and Confluence export) for $39.95US. There's a full feature comparison on the Blue Mango site.

Filed under: Analysis / Opinion, Portables, Apple, Mac Pro, Leopard, iPhone, Apple TV, Holidays

Christmas gifts Apple could give me

It's the Holiday Season, and over the years I have happily spent a lot of my XMAS money with our favorite fruit named company. My love affair with Apple products goes back to the venerated Apple II. I do have a couple of PC laptops in the house, and of course I can also run Vista on VMWare Fusion, but I'm pretty much a Mac guy through and through. Always have been. Always will be.

Nevertheless, I'd like to find some gifts from Apple under my tree this year. They are not big deals, but would be greatly appreciated. So Kris Kringle, if you're listening, pass these on to Mr. Jobs and friends.

  • How about some documentation? I know Steve thinks books are dead, but in the old days Apple documentation was really first rate. Remember that old MacWrite manual? Apple, I know you are in the electronics business, but reading help files on a laptop screen that covers up the application I am trying to learn is a bit of a pain.
  • When you release an update to an iPod, iPhone or OS X how about telling me what the update really does. I know you have gotten better at this, but why should people have to guess all the features and fixes that you have put in? Just own up to it and trust your customers.
  • Find another partner in addition to AT&T for the iPhone. My phone is a great product that is significantly damaged by an inferior, unreliable network. To me, "more bars in more places" means I'm looking for bars to find a stiff drink so I can recover from my frustration with dropped calls, poor signal strength, and sporadic 3G coverage.
  • A lot of your products get really warm. My MacBook Pro can be a sizzler on my lap. My Mac Pro keeps my office pretty warm, and I don't need those high temperatures since I'm in Arizona. Don't get me started on the Apple TV. I do think it is a great product, but I'm thinking I could make a fondue on that top surface. There is no fan in the Apple TV and when I put it in standby to spin down the hard drive it wakes up by itself paying no attention to my command. If I want to be ignored, I can walk into any Home Depot. (Update: Some users say the Apple TV does have a fan. I regret the error. It's still too darned hot!)
OK. it's not a big list, but it's a list just the same. What's on yours? And to all, a good night!

Filed under: Macworld

Show floor video: Screensteps makes documenting easier

Do you make documentation? Do you constantly find yourself having to explain step-by-step procedures to do things on the Mac? BlueMango Learning Systems has been doing this stuff for a while, and the tedium eventually drove them to create their own tool to make things faster. That's innovation for you-- if you can't find a tool, build one (that's how Plasq wound up creating Skitch). Screensteps is truly handy for anyone needing to illustrate steps, like bloggers doing how-to's, all the way up to professional manual-makers. Scott got a quick demo on an excursion to Moscone West. Video after the jump.

Continue readingShow floor video: Screensteps makes documenting easier

Filed under: iPod Family, iPhone

iPhone Coding: iPhone Developer Docs updated to 1.1.2

A few weeks ago, our Mike Rose posted about my 1.1.1 iPhone header documentation. I'm pleased to say that after a huge amount of work, I've updated those docs up to version 1.1.2. The new documents cover all the Objective-C headers for the iPhone and iPod touch 1.1.2 frameworks including updated keyboards and other system-level modifications. If you're wondering about "Oktoberfest", despite the November release date, that's the Apple internal name for the user bundle. Previous bundles included "Heavenly" (1.0.2) and "Snowbird" (1.1.1).

Filed under: How-tos, Productivity, Tips and tricks, Odds and ends

Melman Quicksilver User's Guide

As regular readers know, we here at TUAW are huge fans of Quicksilver from Blacktree. The great thing about Quicksilver is how much functionality it puts at your finger tips. Of course the main problem with Quicksilver is how much functionality it puts at your finger tips! Even those of us who having been using it for years regularly find new and interesting things. There's just so much in there (especially with third-party plugins), but the documentation has been, to be frank, somewhat lacking (though it is getting better). Well now Howard Melman has decided to do something about that, releasing this beautifully illustrated 89-page users guide as a free PDF (Creative Commons). Anybody remotely interested in Quicksilver should have a look, and a big TUAW 'attaboy to Mr. Melman!

[Via Lifehacker]

Filed under: Hardware, iPod Family, Software, Internet, Internet Tools, Apple

Apple adds Nike+ section to iPod Support site


Apple must have heard our jab at their one-line Nike+ Sport Kit support document yesterday and decided to whip up a full-blown Nike+ support section of their much-loved iPod Support site. Delusions of grandeur aside, the support section offers the typical troubleshooting and 'How do I...' sections, along with a video tutorial detailing how to run how to get on your feet with using this slick new kit to enhance your run. It also includes a link to Apple's new Nike + iPod Sport Kit discussions sub-category which lives under their iPod nano forum. While these should be handy new resources for all sorts of internet-related arguments over Nike and why 5G iPods didn't make the cut, just remember to still get out on your feet with your shiny new running kit, as we're pretty sure Apple Stores won't accept "I just never got around to it" as a return excuse.

Filed under: Software, Internet Tools

Sandvox 1.0.2 with new features, demo screencast, intro pricing ends soon

Karelia Software has updated Sandvox, their feature-packed WYSIWYG web design app, to version 1.0.2, bringing a few new features to the table such as a much-requested Format menu. Of course, other bug fixes and the like are included, so check out the release notes for the full details.

In addition to a one-hundredth of a point update, Karelia Software has also created a demo screencast for Sandvox which takes (potential) users through the site creation process and demos the many features Sandvox has to offer, such as adding weblogs and photo albums, as well as the Pro feature lineup. Along with the screencast, Karelia Software has also updated their online documentation with "How do I?", troubleshooting and reference sections.

Last on the Sandvox update is the impending doom of their introductory pricing offer. Presently, a single regular Sandvox license goes for $39 USD, while the Pro version is $69 USD - but only until Friday, June 16th. I couldn't track down what these prices will bump up to, but I'm sure they'll make these look like a good deal. Get it while it's hot.

Tip of the Day

Use Spotlight as a reference tool. Type any word in the Spotlight box and one of the top entries will be a definition. Click on it, and it will bring up the dictionary application to check the word in either the dictionary, thesaurus, Apple database, or Wikipedia.


Follow us on Twitter!
 TUAW [Cafepress]

Featured Galleries

DNC Macs
Macworld 2008 Keynote
Macworld 2008 Build-up
Google Earth for iPhone
Podcaster
Storyist 2.0
AT&T Navigator Road Test
Bento for iPhone 1.0
Scrabble for iPhone
Tom Bihn Checkpoint Flyer Briefcase
Apple Vanity Plates
Apple booth Macworld 07
WorldVoice Radio
Quickoffice for iPhone 1.1.1
Daylite 3.9 Review
DiscPainter
Mariner Calc for iPhone
2009CupertinoBus
Crash Bandicoot Nitro Kart 3D
MLB.com At Bat 2009
Macworld Expo 2007 show floor

 

More Apple Analysis

AOL Radio TUAW on Stitcher