Manual Style Guide


The original rationale for the manual was to be a comprehensive guide for Quicksilver. There were many short tutorials and How-To’s for specific things online but nothing that covered all of Quicksilver in depth. Terminology was inconsistent (particularly what the three panes were called) and there weren’t good explanations of why Quicksilver is a great application that everyone should use. There were pockets of info around and that did draw people of all skill levels to try it and given the nature of Quicksilver’s configuration, it led to a lot of support questions from people who didn’t install everything needed for a particular feature.

Given that Quicksilver has so many functions and each user tends to have specific use cases in mind (for some iTunes control was their introduction, for others it was e-mail and contacts, for others finding and manipulating files) I wanted the manual structured so that people could get directly to functionality that was interesting to them, find complete info, but be shown other things of interest while avoiding duplication as much as possible.


The Introduction is intended for everyone to read through from beginning to end. New users find out what to use Quicksilver for and experienced users have terminology defined and perhaps learn some advanced invocation methods.

The Preferences section walks through all of Quicksilver’s preferences in depth, particularly how to install plugins and setup triggers so later sections could just refer to it.

The Features section covers all the plugins, in detail. Each section includes general usage and configuration instructions, as well as troubleshooting hints and tips for using features more efficiently using advanced Quicksilver features. It includes every cool Quicksilver example I ever found. New users should be able to start using the features quickly and experienced users will probably find something new about many features.


Keep in Mind

The reason to be explicit about things is to reduce the number of support questions. The reason to be comprehensive is to get people to find out and try new features.