docs: Add 3 new Use Case pages #243
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| title: For Engineering Teams | ||
| description: Keep documentation in sync with code changes by automatically generating updates from pull requests | ||
| --- | ||
|
|
||
| Promptless monitors your pull requests. When code changes, it generates documentation updates using PR descriptions and context from Linear or Jira. | ||
|
|
||
| ## WHAT PROMPTLESS ANALYZES | ||
|
|
||
| This is EDIT!!!! | ||
|
|
||
| When a PR is opened, Promptless reviews: | ||
| - The code diff and changed files | ||
| - The PR title and description | ||
| - Related issues in Linear or Jira | ||
| - Historical patterns in your documentation | ||
|
|
||
| ## PUBLISHING MODES | ||
|
|
||
| **Auto-publish mode**: Promptless creates a docs PR linked to your source PR. When your PR merges, the docs PR is ready for review. | ||
|
|
||
| **Draft mode**: Review suggestions in the web interface before any PR is created. | ||
|
|
||
| ## PROVIDING FEEDBACK | ||
|
|
||
| Tag @Promptless in GitHub PR comments to request changes. Promptless updates the suggestion accordingly. | ||
|
|
||
| ## TYPICAL WORKFLOW | ||
|
|
||
| 1. Engineer opens a PR with code changes | ||
| 2. Promptless analyzes the PR and related context | ||
| 3. Promptless generates a documentation suggestion | ||
| 4. Team gets notified in Slack | ||
| 5. Reviewers provide feedback via PR comments or web interface | ||
| 6. Documentation publishes when approved | ||
|
|
||
| ## GETTING STARTED | ||
|
|
||
| <Steps> | ||
| <Step title="Connect GitHub"> | ||
| [Connect GitHub](/docs/integrations/github-integration) to enable PR monitoring. | ||
| </Step> | ||
| <Step title="Create a project"> | ||
| [Create a project](/docs/getting-started) with GitHub as your trigger. | ||
| </Step> | ||
| <Step title="Add context sources (optional)"> | ||
| Connect [Linear](/docs/integrations/linear-integration) or [Jira](/docs/integrations/atlassian-integration) for richer context. | ||
| </Step> | ||
| <Step title="Configure notifications"> | ||
| Set up a Slack channel for notifications. | ||
| </Step> | ||
| </Steps> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
|
Contributor
Author
There was a problem hiding this comment. Citation: Based on the "Support-Driven Documentation" workflow and Zendesk integration details describing how resolved tickets can trigger documentation updates. |
||
| title: Support Tickets to Docs | ||
| description: Automatically identify documentation gaps from support tickets and generate content that helps future customers | ||
| --- | ||
|
|
||
| Resolved support tickets contain valuable knowledge—troubleshooting steps, workarounds, and explanations that could help future customers. Promptless analyzes your Zendesk tickets to identify documentation gaps and generate content based on solutions your team already provides. | ||
|
|
||
| ## WHAT PROMPTLESS DOES | ||
|
|
||
| When a ticket is resolved, Promptless: | ||
|
|
||
| - Identifies patterns across similar tickets | ||
| - Detects topics missing from your documentation | ||
| - Extracts solutions and troubleshooting steps | ||
| - Drafts troubleshooting guides, FAQ entries, and feature explanations | ||
|
|
||
| ## PUBLISHING OPTIONS | ||
|
|
||
| Promptless can publish directly to: | ||
|
|
||
| - Zendesk help centers | ||
| - Intercom help content (Beta) | ||
| - Any documentation platform connected to your project | ||
|
|
||
| ## TYPICAL WORKFLOW | ||
|
|
||
| 1. Support team resolves a ticket | ||
| 2. Promptless analyzes the ticket and related context | ||
| 3. If documentation should be updated, a suggestion is generated | ||
| 4. A technical writer or support lead reviews and approves | ||
| 5. Content publishes to your help center | ||
|
|
||
| ## GETTING STARTED | ||
|
|
||
| <Steps> | ||
| <Step title="Connect Zendesk"> | ||
| [Set up the Zendesk integration](/docs/integrations/zendesk) to enable ticket analysis. | ||
| </Step> | ||
| <Step title="Create a project"> | ||
| Create a project with Zendesk as your trigger. | ||
| </Step> | ||
| <Step title="Configure your documentation platform"> | ||
| Connect Zendesk help center or another documentation platform. | ||
| </Step> | ||
| <Step title="Set up notifications"> | ||
| Configure notifications for your support or documentation team. | ||
| </Step> | ||
| </Steps> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
|
Contributor
Author
There was a problem hiding this comment. Citation: Based on the "Technical Writer Workflow" section describing how writers receive Slack notifications, review suggestions in the web interface, and use the Triggers page for audit trails. |
||
| title: For Technical Writers | ||
| description: Focus on documentation strategy while Promptless handles routine updates and keeps you informed about product changes | ||
| --- | ||
|
|
||
| Promptless handles routine documentation work so you can focus on information architecture and strategy. Instead of attending standups and chasing engineers for context, you get notified when docs need updating—with all the context you need in one place. | ||
|
|
||
| ## HOW PROMPTLESS HELPS | ||
|
|
||
| Promptless monitors your configured trigger sources and notifies you when documentation updates are needed. You receive notifications in a dedicated Slack channel whenever Promptless detects documentation-worthy changes. | ||
|
|
||
| ### CONTEXT AT A GLANCE | ||
|
|
||
| When reviewing a suggestion, you see: | ||
| - The PR or trigger that initiated the update | ||
| - Related Linear or Jira issues | ||
| - Relevant Slack conversations | ||
| - The proposed documentation changes | ||
|
|
||
| ### PROVIDE FEEDBACK | ||
|
|
||
| Use the web interface to: | ||
| - Highlight text and add comments | ||
| - Request changes that Promptless applies automatically | ||
| - Save feedback preferences for future suggestions (e.g., "always include code examples for API endpoints") | ||
|
|
||
| ### AUDIT TRAIL | ||
|
|
||
| The Triggers page shows all events from the last 30 days. Track what triggered each documentation update and audit your process. | ||
|
|
||
| ## TYPICAL WORKFLOW | ||
|
|
||
| 1. Promptless monitors PRs, Slack, and other triggers | ||
| 2. You receive a notification when docs need updating | ||
| 3. Review the suggestion and related context in the web interface | ||
| 4. Provide feedback to refine the suggestion | ||
| 5. Approve and publish when ready | ||
|
|
||
| ## GETTING STARTED | ||
|
|
||
| 1. Connect your documentation platform via [GitHub](/docs/integrations/github-integration) or another doc collection | ||
| 2. Create a project with your preferred triggers | ||
| 3. Set up a dedicated Slack channel for notifications | ||
| 4. Connect context sources like [Linear](/docs/integrations/linear-integration) or [Jira](/docs/integrations/atlassian-integration) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Citation: Based on the "Development Team Workflow" and "Common Use Cases and Workflows" sections which describe how Promptless monitors PRs, analyzes code diffs, and generates documentation suggestions automatically.
View source