Writing rules
Writing rules are the settled decisions that tell Cactus how to write a product’s help pages, answers and changelog, and how its pages are laid out. Each one is kept on Settings › Rules, where you can change who it is for, retire it, or have Cactus learn rules from your team’s writing.
On this page
Read the rules on Settings › Rules
Open Settings › Rules. The page is headed Writing rules and lists every active rule for the product, grouped by the parts of Cactus that honour it: the map, the page layout, page writing, answers and the changelog.
Each rule shows:
- Its sentence, with the words it came from in quotes when it has them.
- A Learned badge on a rule Cactus learned, and who set it and when: a name and a date, or “Learned from your writing” and a date.
- “Said on” and the page it was said on, when the rule names one.
- Its audience, as three choices under the rule.
- For a rule that rewrites pages: how many of them are done, how many live sections cite the rule, and Pages this reaches, which lists each page.
- A learned rule with no page written yet reads “Every page written from now.”
A rule that only the map or the page layout honours shows no page count, because it rewrites no page.
Change who a rule is for
Under the rule, select Both, Customer, or Internal.
Choice | The rule applies to |
|---|---|
Both | The rule applies to What the team reads and what customers read. |
Customer | The rule applies to What customers read. |
Internal | The rule applies to What the team reads. |
Any member of the team can change a rule’s audience. The change is saved at once, and the pages the rule reaches are written again, each going live as it is written.
Retire a rule
You can retire a rule you set yourself. Only a teamspace owner can retire a rule someone else set, and a learned rule, which no member set, can only be retired by an owner.
Under the rule, select Retire.
To take it back, press Retire again or press Escape within 4 seconds. Nothing is sent until those 4 seconds pass.
Once the 4 seconds pass, the rule stops applying, and the pages it reached are written again without it, each going live as it is written.
Add a rule in a team thread
A member of the team can state a rule to the help assistant in a team thread. Cactus records it when the member gives it as an instruction, or when they confirm the wording Cactus proposes.
A rule with no audience named is for both readers. A rule with no reader named is honoured by the pages, the answers and the changelog.
A rule about what exists or how the pages are arranged starts a rebuild.
Learn rules from your writing
On Settings › Rules, select Learn from your writing. Any member of the team can start it.
Wait while the button reads Reading your writing…, until the learn ends.
Read the note under the button. It says Cactus read your writing and wrote what it found below, or why it learned nothing.
Cactus reads the home page of your team’s own site and the replies your team sent customers, including replies in imported conversations. If the team has no site set, only the replies are read.
A learn writes up to 12 rules, each quoting one sentence from what it read. Rules read from the home page are honoured by page writing and the changelog, and rules read from replies are honoured by answers.
A learn replaces the learned rules from the last learn in each place it read. A learned rule you retired is not proposed again.
Rewrite the pages with Generate now
Under Build on the same screen, select Generate now to start a new build. Published pages stay as they are until it finishes.
Generate now is off while a build is running or paused, and Cancel build is on only while one runs. A build that a rule shaped links back to that rule’s row on this screen. Builds are described on Builds.
If a rule doesn’t take effect
What you see | What it means | What to do |
|---|---|---|
“No writing rules yet” | What it means No rule is active for this product. | What to do Select Learn from your writing, or state a rule in a team thread. |
“Only a teamspace owner can retire a rule someone else set.” | What it means Another member set the rule, and you are not an owner. | What to do Ask a teamspace owner to retire it. |
“Couldn’t find that rule.” | What it means The rule is no longer active, or it is not this product’s. | What to do Reload the page to see the current rules. |
“The rule is saved, but Cactus couldn’t start rewriting the pages it reaches.” | What it means The change is kept, but the pages it reaches are not written again yet. | What to do Make the change again. |
“Couldn’t learn from your writing: the reason” | What it means The learn ended with no rules, and nothing changed. The reason can be that there is no writing to read yet. | What to do Select Learn from your writing to try again. |
“Cactus is still reading your writing. The rules will appear here when it’s done.” | What it means The learn has run past 3 minutes. | What to do Wait, then reload the page. |