Using Promptless Capture
Promptless Capture keeps product screenshots in sync with your UI. When code changes affect a documented feature, Promptless Capture identifies which screenshots need updating and regenerates them from your current interface.
Promptless Capture must be enabled for your organization by the Promptless team. Reach out to help@gopromptless.ai or contact us via Slack to get started.
Setting Up Credentials
Section titled “Setting Up Credentials”Promptless Capture needs credentials to authenticate with your application. Configure these as environment variables in your organization settings.
Navigate to Settings
Go to the Settings page in your Promptless dashboard and select the Environment Variables section.
Add Credential Variables
Add variables for your application’s login credentials. The variable names are flexible—use whatever naming convention works for your team. For example:
| Variable Name | Description | Mark as Secret |
|---|---|---|
TEST_ACCOUNT_URL | The login URL for your application | No |
TEST_ACCOUNT_USER | Username or email for the test account | No |
TEST_ACCOUNT_PASS | Password for the test account | Yes |
You might use names like STAGING_LOGIN_URL, QA_USER, or any descriptive names that fit your organization’s conventions.
Save Variables
Click Save to store your environment variables. Variables marked as secrets will have their values hidden after saving.
Warning
Use a dedicated test account for screenshot capture rather than a personal or production account. This ensures screenshots don’t contain sensitive data and provides a consistent UI state.
Tip
Create a test account with access to all features you want to document. If certain features require specific permissions or plan tiers, ensure your test account has the appropriate access level.
Testing Your Setup
Section titled “Testing Your Setup”After adding your credentials, verify that Promptless can capture screenshots correctly.
Start a Manual Task
Go to the New Task page and request a documentation update that involves screenshots.
Review the Results
Check the suggestion to see if screenshots were captured correctly. Look for:
- Successful authentication (no login screens in screenshots)
- Correct page navigation (screenshots show the intended feature)
- Appropriate cropping (relevant UI elements are visible)
Iterate on Configuration
If screenshots aren’t captured correctly, adjust your environment variables or provide additional context in your Long-Term Context files.
Troubleshooting
Section titled “Troubleshooting”Promptless can't log into my application
Verify that your TEST_ACCOUNT_URL, TEST_ACCOUNT_USER, and TEST_ACCOUNT_PASS variables match what you use to manually log in. If your screenshots show the login page, the credentials may be incorrect or the login flow may require additional steps. For applications that use multi-factor authentication, consider creating a test account that bypasses MFA, or contact help@gopromptless.ai for guidance on handling MFA flows.
Screenshots capture the wrong page
Promptless may need additional navigation guidance. You can add instructions in your Long-Term Context to describe how to navigate to specific features. Include details about menu paths, URL patterns, or button sequences needed to reach documented screens.
Screenshots show features that should be hidden
Check your feature flag configuration. The test account may have access to features that typical users don’t see. Consider creating a test account with permissions that match your target documentation audience.
Cropping cuts off important elements
The automatic cropping may need refinement. You can use the Screenshot Editor in the Promptless dashboard to manually adjust crops, or provide feedback that Promptless will learn from for future captures.
Screenshots show loading states or spinners
The page may not have fully loaded before capture. Contact help@gopromptless.ai if you consistently see loading states in your screenshots.
Screenshot Editor
Section titled “Screenshot Editor”After Promptless captures screenshots, you can refine them in the built-in Screenshot Editor. Click any image in the Created Assets section to open the editor.
Editing Tools
Section titled “Editing Tools”The editor includes tools to refine your screenshots:
- Crop to focus on specific UI elements
- Annotate with arrows, boxes, and highlights
- Add text to call out features
- Adjust image dimensions
Managing Edits
Section titled “Managing Edits”The toolbar provides controls for your editing session:
- Save edits commits changes to the screenshot
- Reset edits discards unsaved changes and reverts to the last saved version—useful for starting over without closing the editor
- Cancel Crop exits crop mode without applying the crop, letting you adjust the selection or switch tools
Saved changes are immediately reflected in your documentation suggestions.
When Screenshots Update Automatically
Section titled “When Screenshots Update Automatically”Promptless Capture monitors your triggers and automatically updates screenshots when:
- A GitHub PR modifies UI components referenced in documentation
- A commit changes routes, layouts, or visual styling
- You explicitly request a screenshot update via Slack or the web interface
Screenshots are only regenerated when Promptless detects changes that likely affect documented UI. Minor code changes that don’t impact the visual interface won’t trigger unnecessary screenshot updates.
Need help setting up Promptless Capture? Contact us at help@gopromptless.ai.