Ask the chat to change an article
The chat writes each change as a proposed edit. The article changes only when you accept it.
Before you start
- The chat sees the page you are on, so start on the article.
- To let the chat check what your app shows, link your code. See Link your code.
Ask for the change
- On the article, select Ask, or press ⌘J (Ctrl+J on Windows and Linux). On screen in the chat names the article, so its text goes with your message.
- In the chat, enter the change you want, such as “Make the first step one short sentence.” Then select Send, or press Enter. The chat reads the article, and your code when it is linked, then writes each change as a proposed edit.
In the chat, select Accept or Reject on each proposed edit.
- Accept puts the words in the article. The article then waits for the next publish, unless it holds typed words nobody marked Ready to Publish.
- Reject asks Why?. Enter what was wrong and select Save rule, so Docmunk follows it next time. Every article, the default, keeps the rule for all articles; This article keeps it for this one.
- Skip, under Why?, rejects the edit with no rule.
When an edit says “The text changed since”, the words moved after the chat wrote it. Ask again.
The same edits wait in the article's Edits panel and on Changes › To review, so you can answer them later. Until then, the article shows “Needs you”.
Show the chat what you mean
The page you are on goes with each message. On an article: its text, its pictures by name, and the edits that wait. Select it, then Leave it out of the next message to send without it. Or turn on Its pictures, as pictures, which is slower and costs more.
Select it, then select a picture, a paragraph, or a row on the page. Hold Shift to add more; press Esc to stop.
Adds an article, a screen, a take, or a run from another page. Typing @ does the same.
Drag over part of the screen to send that part as a picture.
Sends a picture of the whole page. The chat gets one only when you add it.
In the article, pick words and select Chat to add them to the chat. With the pointer over a picture or a row, ⌘J adds that thing too.
Ask about the screen
Ask a question the same way, such as “Why does this article need me?” When a reply names a thing you sent, it gives the thing a number. The page outlines that thing with the same number.
To ask from anywhere, press ⌘K, type the question, and choose the result that says “Ask the chat”.
What the chat changes, and how
| You ask it to | What the chat does |
|---|---|
| Change an article's words | Proposes an edit for you to accept or reject. |
| Rename an article | Proposes a title for you to accept or reject. |
| Fill the prompts of an article started from a template | Drafts each prompt as a proposed edit. |
| Remember something for next time | Saves a rule at once: for one article, for a template, or for every article. See Add a writing rule. |
| Retake a picture, or record the way to a screen | Offers a Retake or Walk button. Nothing runs until you select it. |
| Look at your screen | Asks “Send a picture of your screen?” Nothing goes unless you select Send it. |
| Change the help site's look | Changes the draft, with Undo. It goes live when you publish the help site. Owners and admins can do this. |
| Correct what Docmunk read from your code | Changes it at once, with Undo. Owners and admins can do this. |
Chats
- Each chat is yours: nobody else on your team can read it.
- A chat takes its name from your first message. Select the name for New chat, your recent chats, and Open as a page.
- The chat stays open from page to page, and On screen follows you.
- Dock on the right and Float at the bottom right move the chat. In a narrow window, it floats over an open article.
What the chat cannot do
- Change an article until you select Accept.
- Publish.
- Start a run by itself.
- See your screen unless you send a picture.
- Read your code when it is not linked.
- Change the help site's logos or head scripts.
- For a member, change the help site's look or what Docmunk read from your code. Owners and admins can.
Next: Publish articles