Teach conventions with feedback
Overview
Section titled “Overview”A convention is a rule your team wants in every suggestion. Examples include a tone, where changelog entries go, or a kind of change you never document. When you teach Promptless a convention, it records the rule in your Agent Knowledge Base. It reads the rule on later tasks, so you don’t repeat the same feedback on every suggestion.
Teach a convention in either of these ways:
- State it as a standing rule in feedback you give on a suggestion. Use this when a suggestion shows you a rule you hadn’t written down.
- Write it in the Knowledge Base yourself. Use this for rules you already know, so they apply from the first suggestion.
To choose a feedback method for the suggestion in front of you, see Give feedback on a suggestion.
State a convention in your feedback
Section titled “State a convention in your feedback”Promptless records feedback as a convention when it says how Promptless should behave from now on. Feedback that only corrects the current suggestion changes that suggestion and nothing else.
-
Give feedback through a method that reaches Promptless:
-
Request Changes
-
A dashboard comment, or close feedback, with Send to Promptless checked
-
A comment on the docs PR
-
A reply in the Slack or Microsoft Teams thread
-
-
Phrase the rule so it applies beyond this suggestion, with words such as “always”, “never”, “from now on”, or “for all future suggestions”.
Compare a one-off correction with the same feedback written as a standing rule:
| One-off correction | Standing rule |
|---|---|
| ”Make the tone of this page more conversational." | "Make the tone more conversational, and do that for all future suggestions too." |
| "Move this changelog entry into its own suggestion." | "I always want changelog entries in their own suggestion." |
| "This dependency bump doesn’t need docs." | "Don’t create suggestions for dependency bumps.” |
To combine both, fix the current suggestion and state the rule in the same request.
Check what Promptless recorded
Section titled “Check what Promptless recorded”When Promptless records a convention, its notification about the work includes a Recorded: line that links each Knowledge Base file it changed.
To review every recorded convention, open the Agent Knowledge Base. The Recent updates by Promptless list shows each change with its diff and a link to the suggestion that prompted it. See Track what Promptless changed.
If Promptless recorded a rule you didn’t intend, or worded it too broadly, an admin can correct it as the next section describes.
Write a convention in the Knowledge Base
Section titled “Write a convention in the Knowledge Base”Only organization admins can edit Knowledge Base files.
-
In the Promptless dashboard, open Settings and select Agent Knowledge Base.
-
Open the file for the kind of convention you want to add:
Convention File Writing style, terminology, and formatting style/client_style_guide.mdWhom Promptless mentions and how it formats notifications doc_workflow/notification_preferences.mdAny other rule Promptless must follow on every task PROMPTLESS.md -
Add the convention as a plain-language rule.
-
Select Save.
Promptless reads the file on later tasks. For how each file shapes Promptless’s work, see Know the files that shape every task.
See also
Section titled “See also”- Give feedback on a suggestion, to choose how to give feedback on the suggestion you’re reviewing
- Agent Knowledge Base, for viewing, editing, and creating Knowledge Base files
- Filter noise and tune relevance, to scope triggers and teach Promptless which changes to skip
- Route and assign suggestions to the right people, to set routing and assignment conventions in the Knowledge Base