Write with Pageloop

Write an Article

Turn a topic and source material into a page draft for review and publishing.

Write an article

Use Write an article in the sidebar when you have a topic or walkthrough to turn into a new documentation page. Describe what readers need to learn, provide the material Pageloop should work from, and review the resulting draft in Inbox before publishing.

You need an admin or editor role to start an article with Pageloop.

Start with a clear brief

  1. Select Write an article in the Pageloop sidebar. A conversation opens beside your current page.
  2. Describe the article in the message box. Include:
    • Topic and outcome: what the article should cover and what readers should be able to do afterward. Mention anything to leave out.
    • Audience: who will read the article, what readers already know, and any relevant role or prerequisites.
    • Source material: paste relevant notes and facts, or include links to the source records Pageloop should consult through your connected integrations. Identify which material supports the requested steps or behavior.
  3. If the article explains a visual workflow, add a recording:
    • Select Record a flow to walk through the task in Chrome. This option requires the Pageloop Chrome extension; Pageloop prompts you to install it if needed.
    • Select Upload a recording to use a video you already made.
  4. Wait for any uploads to finish, then select Send or press Enter.

A useful brief might be:

Write a how-to on inviting a teammate for workspace admins who are setting up their team. Use the attached walkthrough and the notes below as the source. Cover the invitation steps and what the recipient does next; leave billing out of scope.

A recording is optional. You can start with a written description, or add a description to explain the audience and scope of a recording.

How the draft is structured

Pageloop chooses the closest matching template from your workspace's templates and follows that structure. Templates guide the shape of the article, rather than supplying the facts about your product.

See Style and Templates for guidance on configuring your workspace's writing style and templates.

The result is a proposed page draft with a title and article content, not just an answer in the conversation. Review the draft's headings, explanations, and any task steps against your brief and source material. The structure depends on the template and the subject; not every article needs the same sections.

Answer questions before Pageloop finishes

Pageloop may pause for clarification before finishing the proposal. Open the request in Inbox to see what needs your input. Each question explains the decision your answer will make.

Choose an offered answer or type your own, review the answers, and select Suggest the changes to let Pageloop continue. You can also answer through the item's conversation in the side panel. Answering questions resumes drafting; it does not publish the article.

Review and publish

After you send the request, the conversation confirms that Pageloop is drafting and offers Open the Inbox. Pageloop sends an email when the work is done.

  1. Open Inbox and select the proposal for your article.
  2. Review the proposed page and its content. Check the audience, terminology, facts, steps, and any images before approving the draft. Use the Article tab to read the page and the Changes tab to review proposed edits where available.
  3. Make corrections or ask Pageloop for a revision in the item's conversation.
  4. Use the proposal's publishing controls when the article is ready. The publishing destination depends on your workspace's connected knowledge base. For repository-backed documentation, complete the pull request or merge request review and merge process before treating the page as published.

Starting a request and receiving a draft do not publish a page. The draft stays a proposal until you complete review and publishing.