---
title: "Writing tips"
manual: "Backend Manual"
version: "1.1"
permalink: "https://docs.typo3.org/permalink/proudnerds/pn-backend-manual:writing-tips@1.1"
source: "WritingTips.rst"
rendered: "2026-10-17T07:19:18+00:00"
---

# Writing tips {#writing-tips}

-   Write for the editor, in their language and with the labels of their
    backend language: **Content > Layout**, not **Web > Page**.
-   One `##` per subject the editor looks for (a page type, a content
    element, a menu), with `###` for the tasks: *Create a news item*,
    *Fields*.
-   Steps as a numbered list, fields as a table *Field | What to fill in*.
-   Do not write numbers in the headings; set
    [numbered: true](https://docs.typo3.org/permalink/proudnerds/pn-backend-manual:confval-option-numbered@1.1) instead. The numbers are
    added after the anchors are made, so `## News items` keeps
    `#manual-news-items` when a chapter is added before it. A `###` before
    the first `##` is not numbered.
-   Keep links within the manual out of the introduction: it is also shown on
    the dashboard, where they do not work.
-   Update `version` and `date` in the front matter with every change. The
    extension does not guess the date: the modification time of the file is the
    time of the last deploy, and git is usually not on the server. To make it
    automatic, let a pre-commit hook in the project set `date` to today when
    the manual is in the commit.
-   Set [feedback](https://docs.typo3.org/permalink/proudnerds/pn-backend-manual:confval-option-feedback@1.1) and read what comes in: the
    questions of readers show what is missing.
-   Avoid text that only makes sense in another format ("Ctrl+click in Word").