Practical foundations for customer help websites.
Explore customer help websites, with practical workflows, a working example and checks for common mistakes.
Explore the guide ↗Knowledge Base Design is a focused resource for support content designers, exploring customer help websites through the work people actually need to perform. For this topic, the workflow is to group material by user need, write task-focused answers, and review unresolved searches. This guide uses a help content task map to hold the decisions together and examines search vocabulary, task prerequisites and article maintenance as distinct quality concerns.
The example involves a customer seeking help after an unfamiliar error message; it is an illustrative exercise for this subject, rather than a reported client result. A knowledge base should use the customer's vocabulary. Distinguish task instructions from conceptual help and inspect unsuccessful searches, which can reveal a missing article or a label users do not understand.
A closer look
WEB / 10 SECTIONSStart by describing the task that makes customer help websites relevant now. Use the situation of a customer seeking help after an unfamiliar error message to identify the practical question before choosing a method. A concern involving search vocabulary may require different evidence from a concern involving task prerequisites.
Keep those questions visible in a help content task map, alongside the intended outcome. The scope of customer help websites becomes easier to discuss when an agreed requirement is clearly distinguished from an idea that still needs investigation. Before proceeding with customer help websites, decide whether the current state of article maintenance creates a dependency that needs another person's input.
A help content task map
Use a help content task map as a shared reference for this piece of customer help websites. The record is especially useful when support content designers need to explain why a particular route was chosen. Connect the entry about search vocabulary to the relevant evidence for customer help websites, rather than copying information without its source context.
Review a help content task map after a meaningful change; an abandoned reference can mislead the next person working on customer help websites.
Group material by user need
The first working stage is to group material by user need. In the example involving a customer seeking help after an unfamiliar error message, identify which input is needed before this action can produce a dependable result. Consider how questions about search vocabulary affect the starting conditions for the action to group material by user need, including information that has not been confirmed.
Record the outcome in a help content task map and explain any limitation before asking somebody to write task-focused answers. This creates a traceable starting point for customer help websites, making an incomplete input easier to recognise before it influences the rest of the work.
Write task-focused answers
Continue by deciding how to write task-focused answers under the agreed conditions. The handoff from the first stage of customer help websites should contain the information this action actually requires. Before you write task-focused answers, inspect task prerequisites and identify any assumption that has become doubtful.
If the situation involving a customer seeking help after an unfamiliar error message reveals a different requirement, update a help content task map before expanding the work. A visible change decision keeps customer help websites coherent and helps the next participant understand whether the original scope still applies.
Review unresolved searches
The third stage is to review unresolved searches, bringing the current piece of customer help websites to an understandable state. Check article maintenance against the agreed purpose of customer help websites, not merely against a list of completed activities. Use a help content task map to identify follow-up responsibilities and relevant limits.
In the example of a customer seeking help after an unfamiliar error message, ask what the receiving person would need before relying on the output. Closing this stage of customer help websites clearly prevents an unfinished dependency from being mistaken for an accepted result.
Avoid creating a library that reflects product terminology users do not know
06 / 10A specific failure pattern in customer help websites is creating a library that reflects product terminology users do not know. It can create a gap between the appearance of progress and the actual outcome needed by support content designers. Check whether search vocabulary was understood before the action began and whether task prerequisites was examined by somebody with the relevant context.
Capture the correction in a help content task map, including its effect on article maintenance. The aim is to reduce the opportunity for creating a library that reflects product terminology users do not know to recur, while keeping the process proportionate to the work.
Work through a realistic situation
07 / 10Consider a customer seeking help after an unfamiliar error message as a small rehearsal of customer help websites. Write down the request and expected result, then identify who performs the action to group material by user need. Before moving to the instruction to write task-focused answers, ask which information the next participant needs.
Use a help content task map to preserve any question the example exposes, especially where search vocabulary is uncertain. Then decide how to review unresolved searches without hiding a concern about article maintenance.
Check article maintenance
The review criteria for this guide are search vocabulary, task prerequisites and article maintenance. Examine each criterion separately in the context of customer help websites, because a positive finding in one area does not settle the other questions. For support content designers, a useful review records what was examined and how the finding affects the next action.
Connect the evidence to a help content task map, including any limitation in the material available. In the situation involving a customer seeking help after an unfamiliar error message, identify which finding would prevent a responsible handover. This approach makes the review of customer help websites explainable, rather than treating an unexplained approval label as evidence that the task is ready.
Keep the guidance useful after the first pass
Maintenance of customer help websites should respond to changes in the task, its inputs and its responsible people. Assign an owner to a help content task map and explain which events should trigger another review. A changed assumption about search vocabulary may affect the earlier decision to group material by user need; a concern about article maintenance may require a new closing check.
Remove obsolete directions from a help content task map deliberately so that earlier versions do not compete with approved guidance. When task prerequisites changes, explain whether the instruction to write task-focused answers needs different inputs or a revised decision.
Begin with one bounded task involving customer help websites rather than a complete redesign of the surrounding operation. Prepare a help content task map, work through the three actions and inspect the result using the criteria for search vocabulary, task prerequisites and article maintenance. Ask someone from the intended audience of support content designers to identify a point that still needs clarification.
Compare that observation with the example of a customer seeking help after an unfamiliar error message, then choose a specific change worth testing.