How to Enable WriteAssist in Your Starter Topic

How to Enable WriteAssist in Your Starter Topic

WriteAssist is ClickHelp’s AI-assisted drafting and editing toolkit. In this guide you’ll enable WriteAssist in a starter topic and use it to accelerate content creation while preserving your brand voice and terminology. This task is essential for teams that want to scale authoring without sacrificing accuracy or consistency.

Prerequisites

  • You have created a starter topic in your portal and opened the editor for that topic.
  • Your portal is configured with an active language and branding profile.
  • API access or internal agent usage is enabled if you plan to use external AI agents in addition to WriteAssist.

Activate WriteAssist

  1. Inside the topic editor, locate the WriteAssist toggle in the right-hand panel under AI Tools.
  2. Switch On to enable real-time drafting suggestions and content improvements as you type.
  3. Choose a tone and audience profile that matches your portal’s target. This ensures that suggested phrasing aligns with your brand voice and the readers’ expectations.

What you’ve accomplished: WriteAssist is active, and you can begin drafting content with AI suggestions immediately. What comes next: start writing your first topic, then use AI prompts to create outlines, refine structure, and improve clarity.

Using AI prompts to accelerate drafting

  • Start with a concise description of the user task you’re documenting, for example: "How to reset a password in the admin portal."
  • Ask WriteAssist for an outline: "Provide a three-step outline for resetting a password, including prerequisites and expected outcomes."
  • Accept, modify, or expand the AI-generated outline. Use inline edits to tailor steps to your exact UI labels and terminology.

Quality and governance

Even with AI assistance, you must maintain governance. Validate AI suggestions against your Single source of truth and ensure that all steps map to the actual UI labels in your portal. Update llms.txt references if you migrate topics to new sections or change terminologies.

What to do next

  1. Define taxonomy, snippets, and conditions to enable reuse
  2. Publish your branded portal and test AI search
Warning: Do not rely solely on AI for factual accuracy. Always verify product steps against your UI and update the llms.txt mapping to reflect any changes in the user interface.