WindoorERP Documentation 19.0

Write a manual article

2 min read Updated 2026-08-28 WindoorERP 19.0

What this does

The house rules for writing manual articles people actually find and finish.

Before you start

  • Read the failed-search list first. Write what was asked for rather than what is easy to write.
  • Check no article covers it already — a second article splits the search ranking between them.

Steps

  1. 01
    Create the topic under the right section and pick a template — one article shape, every time.
  2. 02
    Title it as a task: "Create a cutting list", never "Cutting lists".
  3. 03
    Open with What this does — one paragraph, in plain words, answering why anyone would open the screen.
  4. 04
    Put the procedure in one numbered Steps list. It is what task mode walks, so keep it to the main path.
  5. 05
    Add detail as sections and sub-sections; use callouts for the note, the warning and the worked example.
  6. 06
    Finish with Common mistakes — the section readers use most.
  7. 07
    Fill the keywords with shop-floor vocabulary, machine names and Arabic variants.
  8. 08
    Bind the screen it belongs to, so it surfaces in context.
  9. 09
    Send it for review.

House style

  • One task per article. Length is a symptom; covering two tasks is the disease.
  • Name what is on screen. Bold the labels exactly as they appear, and use › between menu levels.
  • Write the mistake, not the ideal. "Cutting from a list printed before the last design change" helps; "ensure accuracy" does not.
  • Structure is not decoration. Sub-headings become the reader's table of contents.

Important

Article bodies are term-translated HTML. An Arabic body must mirror its English source element for element, or the translation is refused and the reader silently gets English. Change the structure and the translation must be regenerated with it.

Common mistakes

  • Covering two tasks in one article because they share a screen.
  • Writing the happy path only. The reader who opens the manual is usually the one it went wrong for.
  • Leaving keywords empty, so the article exists but nobody finds it.

Was this article helpful?

Running a window or door factory?

Ask for a demo