The Knowledge Base Article Builder turns a task description and a list of steps into a complete, well-structured help article. Good support documentation follows a predictable pattern so readers can self-serve fast: a summary that confirms the outcome, prerequisites, numbered steps with optional screenshots, a troubleshooting section, and links to related articles. The tool assembles exactly that from your inputs.
How it works
The builder maps your inputs onto the standard help-centre article skeleton:
- Summary and prerequisites. A short outcome statement plus anything the reader needs before starting (an account, a permission, a connected integration).
- Numbered steps with screenshot placeholders. Each step you enter is numbered in order, and a
[Screenshot: …]placeholder is inserted so you can drop in an image where it clarifies. - Troubleshooting and related links. Common errors with their fixes are listed to catch users where they get stuck, followed by links to adjacent articles so readers can keep going.
Tips and notes
- Title the way users search. Write the title as the task in plain words — “How to reset your password” beats “Password management overview.” Match the phrasing people actually type.
- Front-load the outcome. The summary should say what the reader will have done by the end. If they’re in the wrong place, let them leave in two seconds rather than five steps.
- Keep steps atomic. One action per numbered step. If a step contains the word “and,” it’s probably two steps — splitting them makes the article far easier to follow.