StepSnap is a Chrome extension designed to help users create engaging, step-by-step guides quickly and easily directly from their browser. It streamlines the process of documenting workflows, tutorials, or processes by capturing user interactions and generating structured guide content.
- One-Click Recording: Start and stop guide recording with a simple click on the extension icon.
- Real-Time Status: Visual feedback in the popup indicates whether the extension is recording or idle.
- Content Generation: Automatically captures user interactions (clicks, navigation) to build a structured guide.
- Save & Export: Once stopped, the guide is compiled and ready to be saved or exported (future capability).
- Google Chrome browser
- Basic understanding of Chrome extensions
- Clone the repository (or download the source code).
- Open Chrome and navigate to
chrome://extensions. - Enable Developer mode (toggle switch, usually in the top-right corner).
- Click Load unpacked.
- Select the
guide-creatorfolder you cloned/downloaded.
The extension icon should now appear in your browser toolbar.
- Navigate to the web page where you want to create a guide.
- Click the StepSnap extension icon in the toolbar.
- Click Start Recording in the popup.
- Perform the actions you want to document (e.g., click buttons, fill forms, navigate).
- When finished, click Stop Recording.
- The extension will process the interactions and save the guide.
guide-creator/
├── manifest.json # Extension configuration and metadata
├── src/
│ ├── background/ # Background service worker
│ │ └── background.js # Handles extension lifecycle and messages
│ ├── content/ # Content scripts injected into web pages
│ │ ├── content.js # Interaction tracking and DOM manipulation
│ │ └── content.css # Styling for highlighted elements
│ └── popup/ # Popup UI
│ ├── popup.html # Popup HTML structure
│ ├── popup.css # Popup styling
│ └── popup.js # Popup logic and event handling
└── README.md # Project documentation
- UI Changes: Edit
src/popup/popup.htmlandsrc/popup/popup.css. - Background Logic: Modify
src/background/background.js. - Content Interaction: Update
src/content/content.jsandsrc/content/content.css.
After making changes to the code:
- Go back to
chrome://extensions. - Find the Guide Creator extension.
- Click the Reload button (circular arrow icon).
ISC