Skip to main content

Prompt Rules

Purpose

Use these rules when asking Codex or Claude to draft a LinkUp KB article. The goal is simple public help plus clear implementation truth.

Required prompt inputs

Input What it means Example
Audience Who the page is written for. attendee, organizer, scanner, internal team
Topic The task or question the page answers. Buy a ticket
Doc type The shape of the article. how-to, troubleshooting, reference, policy
Feature area The product area being documented. payments, scanning, Discover, admin
Source context The docs, code, screenshots, or notes the writer should rely on. Route, screen, model, test plan, or audit note

Prompt rule

Ask for one page at a time. Include source context before asking for the final article. If the source is uncertain, ask the model to mark it with [VERIFY: ...].

Banned habits

  • Do not invent button names.
  • Do not describe planned features as live.
  • Do not use vague instructions like “click the button”.
  • Do not bury implementation gaps in friendly wording.

Implementation check table

Expected behavior Status Surface Manual check
The prompt produces a public article and internal implementation notes. Implemented Authoring process Generate one test page and confirm both sections exist.
The prompt supports BookStack-ready output. Implemented BookStack Paste the article into BookStack and confirm headings/tables render cleanly.

Gaps / notes

The reusable DOCX prompt should be updated after these first pages settle.