Gallery Workflow Style Guide
The Alfred Gallery strives for predictability between workflow READMEs so users have an easier time navigating and picking up new workflows. While exceptions are inevitable, this document covers how to remain consistent in common situations.
Modeling your workflow’s internal About after this guide is highly encouraged and makes it a stronger candidate for inclusion in the Gallery.
Index
- Introduction
- Universal Actions
- Screenshots
- Modifiers
- Alternative Invocations
- Hotkeys
- Workflow Configuration
- Setup
Introduction
Start with ## Usage and one or two short sentences describing the main action on the workflow. Search is a great way to begin if the action involves any type of filtering through results.
End with via the `INPUT` keyword. Use keyword even if referring to a Script Filter, File Filter, or similar. Occasional use of with instead of via helps to mix it up.
Universal Actions
When describing a Universal Action, end with via the [Universal Action](https://www.alfredapp.com/help/features/universal-actions/), linking to the documentation. Use Universal Action even if referring to a File Action.
Screenshots
Continue with an image directly illustrating the text. See Taking Good Screenshots.
Modifiers
List modifiers below the image in the format * KEYS ACTION. Use ↩︎⌘⌥⌃⇧ for the keys, surrounding each character in the <kbd> HTML tag.
For previewing with Quick Look, use * <kbd>⌘</kbd><kbd>Y</kbd> (or tap <kbd>⇧</kbd>) Quick Look SOMETHING.
Alternative Invocations
If there is both a keyword and Universal Action for the same task, use Alternatively, and another screenshot.
Hotkeys
Mention Hotkeys with Configure the [Hotkey](https://www.alfredapp.com/help/workflows/triggers/hotkey/) SOMETHING, linking to the documentation.
Workflow Configuration
Configuration should be explained in the workflow itself, but it is OK to mention the occasional relevant option users might otherwise miss. Describe it with [Workflow’s Configuration](https://www.alfredapp.com/help/workflows/user-configuration/), linking to the documentation.
Setup
Add ## Setup above the Usage section if extra manual steps are required before using the workflow. Leave out required Configuration items because Alfred itself warns of those. Leave out installing apps, Homebrew formulae, or setting API keys because the Gallery mentions those in a separate section.
