Interface Guide
Purpose: Walk through Swifter as a tool — how to operate it from sign-in through merged pull request.
This guide is the operator's tour of the platform. It assumes nothing beyond a fresh login and walks through the screens, controls, and actions a team member encounters from the moment they land on Home to the moment a work item moves to Done. It is deliberately UI-shaped: here is the button, here is what it does, here is what you see next.
The flow below is the spine of the guide. Each step maps to one page in this section, and each page focuses on the controls, panels, and decisions you meet at that stage. Read it linearly the first time; come back to individual pages when you need a refresher on a specific tab or action.
Pages in this section
| Page | What it covers |
|---|---|
| Getting Started | Sign in, Home, the organisation switcher, and the integrations that must exist before any project can be created. |
| Projects and Work Items | The Create new project dialog, modules, greenfield vs brownfield wiring, syncing the backlog from the issue tracker, and creating work items directly in the platform. |
| Running Agents | Pressing Start on a work item, the session and branch it creates, picking the right agent, running a command, and reviewing outputs in the App and Dev tabs. |
| App Tab | Per-sub-section reference for Pages, Data model, Logic, API Library (incl. OpenAPI import paths), Components, and Styles — what each shows, what you can do in it, and when to open it. |
| Previews and Manual Checks | Building and opening the Preview, manual checks against acceptance criteria, embedded Storybook for components, and the Test tab. |
| Pull Requests and Merge | Create pull request, Check pull request status, Complete, and the Force Merge path when conflicts appear. |
| Settings | Organisation-scope settings (credentials, org-wide options) and project-scope settings (project configuration, modules, People — admin vs product-engineer roles). |
| Organization Dashboard | The analytics surface inside organisation Settings — Organisation tab (compare projects), Projects tab (one project over time), and the work-items table with per-item metrics. |
How this fits with the rest of the cookbook
The Interface Guide answers "what do I press?". The companion Journeys Guide answers "what do I run end-to-end on a real piece of work?", and the Appendix answers "what is Swifter and why is it shaped this way?". If you are mid-task and need to remember which control lives where, you are in the right place; if you are planning a delivery shape, the Journeys Guide is the better starting point.