Structure

Inline help text creates dependency, not clarity

Inline help is a symptom

Every character you add below a field label is an admission that the field itself isn't clear. That parenthetical hint about character limits, that example of "proper format," that reminder to check the style guide—all of it signals that your content model leaks implementation details instead of surfacing editorial intent.

The problem isn't help text. The problem is needing help text because the field's purpose isn't architecturally obvious. When you write "Enter the product SKU (example: PRD-2024-001)" under a field labeled "SKU," you're papering over a structural gap. SKU format belongs in validation rules, not prose reminders. The field label should make the why clear; the system should enforce the how.

Help text creates invisible knowledge debt

Inline hints don't scale. You write them once, for the CMS you have today, aimed at the editor you imagine. Then:

  • The content model changes and the hint becomes stale
  • A new editor joins and reads the hint as gospel, not guidance
  • An API integration bypasses the CMS entirely and the "required format" stops being required
  • Someone copies the field to a new content type and the help text no longer applies

You end up maintaining two parallel systems: the actual validation logic in your code, and the explanatory prose in your admin interface. They drift. The hint says "optional" but the template throws an error if it's empty. The example shows title case but your front-end lowercases everything. Editors learn to ignore help text because it's been wrong before.

What belongs in a field vs. what belongs in documentation

Field-level help should answer exactly one question: What is this field's editorial purpose in this specific content type? Not how to format it. Not what happens if you leave it blank. Not where it appears on the page. Those are system behaviors that belong in content-ready checklists or validation messages, not ambient interface text.

If you need to explain character limits, build a live counter. If you need to show format requirements, add format examples to the error state, not the empty state. If you need to clarify field relationships ("this overrides the category default"), that's a sign your content model has hidden dependencies—fix the model, don't narrate around it.

Inline help works when it clarifies editorial judgment: "Deck: the one-sentence argument for reading this story." That's purposeful. "Deck: appears below the headline on article pages, max 120 characters"—that's a technical spec masquerading as guidance.

Help text trains editors to defer understanding

When editors can always glance down for a reminder, they never internalize the content model. They learn the CMS as a collection of labeled boxes with instructions, not as a structured system with consistent logic. That's fine for one-off contributors. It's a disaster for a team trying to maintain coherent information architecture over time.

You want editors who understand that "Featured Image" isn't just "the big picture at the top"—it's the content's visual anchor across every template that references it, from archive cards to social shares to email digests. That understanding doesn't come from a tooltip. It comes from a content model that makes relationships explicit and consequences visible.

Document your content types in a style guide with examples, context, and rationale. Link to it from your CMS dashboard. Make it versionable, searchable, and separated from your field schema. When the model changes, you update one artifact, not forty scattered help strings.

When help text is actually useful

Some fields do need inline clarification:

  • Judgment calls the system can't validate: "Hero image: choose the most visually distinctive shot, not necessarily the first in the gallery"
  • Non-obvious scope: "Internal notes: only visible to editors, never published"
  • Disambiguation between similar fields: "Pull quote vs. callout: pull quotes are excerpted from the body text; callouts are editor-written highlights"

Notice what those have in common: they describe editorial decision-making, not technical compliance. The system can't tell you which image is "most distinctive." It can tell you when a filename violates your naming convention—so handle that with validation, not a hint.

Your CMS should teach the model, not narrate the interface

Strip out help text that duplicates what the system already enforces. Remove examples that describe format instead of purpose. Delete reminders that should be validation rules. What's left will be smaller, clearer, and actually meaningful: the editorial intent that gives each field its reason to exist.

If half your fields still need help text after that edit, you don't have a documentation problem. You have a content model problem. Fix the architecture. The interface will clarify itself.

← All posts