FAQ Creation Rules

Delete after old rules: ClickUp

 

Structure

 

  1. Title describes a problem or asks a question;

  2. Max title length is 100 symbols. Optimal title length is up to 60 symbols;

  3. 1 sentence = 1 step: Do > This > Where;

  4. After each instruction list, add a sentence describing the result — "The text is now added", "The link is now created", etc;

  5. Use a numbered list for steps that must be followed in order;

  6. Use a bulleted list for unordered items and options to choose from;

 

Formatting

 

  1. Write navigation paths in [i]italic[/i] with spaces around the arrow (e.g. [i]Menu → Submenu → Page[/i]). Do not use [i]italic[/i] in other places;
  2. Use icons to mention buttons. If the button has a text label, describe it using that label. Never use images;
  3. Verify icon names [icon="icon-name"] match the actual interface — check the feature's own FAQ article for the correct icon class;
  4. Use bold text only to highlight important words, short phrases or section;

 

Images

 

  1. Width: 100% — when the overall context is important for understanding the image: navigation, several connected sections, a wide table, the arrangement of elements on the page, or small details.
    535px — when the image shows one self-contained element, such as a modal window, form, message, or small interface fragment that remains clear and readable when reduced.

  2. Should have short descriptive alt (relative to it);

  3. Should not contain sensitive data;

  4. Do not add a "Preview" or "Ads" label above images or videos.

 

Language & Tone

 

  1. Never use "click" — always use "press" and "select";
  2. Never use "e.g." — always use "for example";
  3. Avoid "please";
  4. Check all links in FAQ;
  5. Check translations.

 

Content Integrity

 

  1. For every noun or action in the article, check if it matches any other FAQ article title — read the article, extract all features, technical terms, and action names, then search the saved FAQ articles by title — if a match exists, add a link to that article.
  2. Always check for terms explained in the articles https://site.pro/faq/55608/ and https://site.pro/faq/3820/ — if a match exists, add a link to that article.

 

Aliases (block at the bottom):

 

  1. Should be 10 aliases for 1 FAQ (including all language variations)
  2. Aliases shouldn't look artificial

Prompt example:

  • ~~~~ search using these FAQ rules, replace in Texts using SPML rules ~~~~

  •  

Main list formatting rules:

  • [list type="numbers"] — used for sequential steps, such as instructions where order matters.
  • [list] or [list type="letters"] — used for options or items that do not follow a strict sequence.
  • Every list must be closed with the [/list] tag.
  • Each separate list, including nested lists, must have its own [list] and [/list] tag pair.

Item format inside a list:

  • text
  • [list type="numbers"]
  • First step...
  • Second step...
  • [/list]

Rules for item content:

When a list item contains several paragraphs or additional text that is not the next step, wrap the content in 

[p]Example

Example

[/p]Example

[/p] should always be in the beginning of the last line that should be isolated from the numbered list.

An image must never be a separate list item. It must be placed inside [p] or in the same line as the text.

Correct example:

text
[list type="numbers"]
[p]Prepare the necessary materials.
Description text
{faq_image_small}
Text continuing after the image.
[/p]Final paragraph of the list item.
[/list]

Additional rules:

 

  • Nested lists follow the same rules. Each nested list must have its own [list] and [/list] tags.
  • Videos must always be placed outside any list on a separate line.
  • [p][/p] should be used only when a single list item needs to contain multiple blocks of text or images.
  • Alphabetical lists must be placed inside [list type="letters"][/list]. When encountering lists not placed inside [list] type tags, format like this: