# KB Article Template

## Purpose

Use this template for every LinkUp knowledge base page. It keeps the public help simple while giving us a small implementation check under the same article.

## Page template

<table id="bkmrk-section-what-to-writ"><tbody><tr><th>Section</th><th>What to write</th></tr><tr><td>Title</td><td>Use a short task-based title, such as **Buy a ticket** or **Confirm an offline reservation**.</td></tr><tr><td>Public help</td><td>Explain the task in plain language for the reader. Use short steps and avoid developer wording.</td></tr><tr><td>Expected LinkUp behavior</td><td>State what the product should do when the feature works correctly.</td></tr><tr><td>Implementation status</td><td>Mark the feature as Implemented, Partial, Legacy Only, Missing, Planned, or Needs Verification.</td></tr><tr><td>Verification checklist</td><td>Add simple checks that prove the feature works in the web app, mobile app, admin panel, or scanner app.</td></tr><tr><td>Gaps / notes</td><td>Record anything unclear, risky, or different from the intended behavior.</td></tr></tbody></table>

## Writing rules

- Write for one audience at a time.
- Use second person: “you”.
- Keep each step to one action.
- Use **bold** for buttons, screens, and fields.
- Use `[VERIFY: ...]` when a screen, button, or workflow has not been confirmed.
- Do not describe planned features as live features.

## Implementation check table

<table id="bkmrk-expected-behavior-st"><tbody><tr><th>Expected behavior</th><th>Status</th><th>Surface</th><th>Manual check</th></tr><tr><td>Every KB page includes public help and internal implementation notes.</td><td>Implemented</td><td>BookStack</td><td>Create or review a page and confirm both sections exist.</td></tr><tr><td>Unconfirmed UI is marked before publishing.</td><td>Implemented</td><td>Authoring process</td><td>Search the article for `[VERIFY:` markers before release.</td></tr></tbody></table>

## Gaps / notes

This is the first local standard. Update it after the first five to ten articles if the structure feels too heavy or too light.