📖 Explaining Features & Documentation
ChatGPT can turn complex platform features into clear, step-by-step guides, quick starts, and troubleshooting tips — then point users to the right official documentation.
📝 Plan
💡 Explain
🔗 Link Docs
♻️ Maintain
🔎 Overview
Use ChatGPT to turn complex platform features into clear, step-by-step guides, quick starts, and troubleshooting tips—then point users to the right official documentation.
- Feature explainers for non-experts, focused on tasks and outcomes.
- How-to sequences with numbered steps, tips, and pitfalls.
- Quick starts that get users productive in 2–3 minutes.
- Troubleshooting trees that branch by symptom and fix.
- Glossaries & tooltips that translate product jargon.
- Doc pointers that link to vendor help pages and videos.
🪄 Feature Explainers (Task-First)
Explain what a feature does, why it matters, and when to use it—then provide a minimal example.
Show preview
What is a “Database Asset” in LibGuides?
A Database Asset is a reusable record for a database (title, description, URL, tags). You add it once, then drop it anywhere in your guides to keep info consistent.
- Why it matters: one update fixes every guide.
- When to use: linking to licensed databases across multiple courses.
Show code
"Explain the feature to a non-expert:
- What it is, why it matters, when to use, and a minimal example.
- Keep it under 150 words, plain language.
FEATURE: <feature name>"
🧭 How-To (Step-by-Step)
Turn a task into a numbered sequence with prerequisites, steps, and a quick validation check.
Show preview
- Prereqs: You can edit the guide; you have the database URL.
- Steps: Content → Add/Re-use Box → “Database” → select asset → Save.
- Check: Click the link—does it open the proxy login and then the resource?
Show code
"Write a step-by-step 'How-To' with:
- Prerequisites (bullets)
- Numbered steps (5–8)
- 'Check your work'
TASK: <task>"
⚡ Quick Starts (2–3 Minutes)
Offer a fastest-path version: 3–5 bullets to get a user from zero to working.
Show preview
- Open your guide → click Edit.
- Add a Database box → choose the existing asset.
- Publish your changes.
Show code
"Create a 'Quick Start' for <feature/task> in 3–5 bullets.
Assume first-time user; keep steps atomic; bold UI labels."
🛠️ Troubleshooting by Symptom
Branch by what the user sees, suggest likely causes, then list fixes and when to escalate.
Show preview
Symptom: “Database link shows a 404.”
- Likely causes: URL changed; proxy prefix missing; asset not published.
- Fix: Check the Database Asset URL; ensure proxy prefix; republish box.
- Escalate: If proxy still fails, contact e-resources with the URL & timestamp.
Show code
"Build a troubleshooting guide:
- Symptom
- Likely causes (3 bullets)
- Fix (steps)
- Escalate when (1–2 lines)
Symptom: <describe symptom>"
Translate jargon into plain language + one-line “why it matters.”
Show preview
- Asset: a reusable record (e.g., database) you can place on many pages. Why: update once, fix everywhere.
- Proxy: the login layer that proves affiliation so licensed content opens off-campus.
- Friendly URL: a short, human-readable link to a guide or page.
Show code
"Create a 5-term glossary with:
- Plain-language definition (1–2 lines)
- 'Why it matters' (1 line)
Terms: <list terms>"
🔗 Point to Official Documentation
Close each explainer with authoritative help links. Keep link text descriptive.
♿ Accessibility & Style Guardrails
- Headings: Use logical order; keep titles descriptive.
- Plain language: Prefer verbs and short sentences.
- Color contrast: Ensure readability.
- Links: Use meaningful text.
- Images: Provide alt-text.
- Maintenance: Reuse content; date-stamp changes.
Written by ChatGPT. Edited by Peter Z. McKay. [Date]
