Tip: Working Effectively with the Help System
Recommendation
Use get_template_confidence() to decide whether to trust a template before surfacing it to users.
Templates are auto-generated and rated over time through record_template_feedback(). A template with a low confidence score has received negative feedback or has never been rated — showing it without checking first erodes user trust in the help system as a whole.
from help.feedback import get_template_confidence, record_template_feedback
score = get_template_confidence("con-progressive-depth")
if score >= 0.7:
# safe to surface
...
# After the user rates it:
record_template_feedback("con-progressive-depth", "positive")
Why: Confidence scores are the help system's quality signal. Ignoring them means stale or poorly rated templates surface as often as good ones.
Tradeoff: Templates with no feedback history return a neutral score, not zero. If you gate on a high threshold (for example, >= 0.8), new templates are suppressed until they accumulate ratings — plan for a warm-up period or seed ratings during generation.
Related functions
| Function | What it tells you |
|---|---|
get_template_confidence(template_id) |
Current confidence score for one template |
record_template_feedback(template_id, rating) |
Submit a rating and get the updated score back |
get_usage_weights(days=30) |
Relevance weights across all templates over a time window |
search_by_tag(tag, sort_by_usage=True) |
Find templates by tag, ranked by usage frequency |
Unresolved references
Auto-generated by attune-author fact-check. Review and either fix the source code, fix this doc, or add an override.
| Location | Severity | Issue |
|---|---|---|
| Line 19 (code fence) | error | from help.feedback import … — module not importable |