FAQ Creation Rules

Structure

  1. Title describes a problem or asks a question;

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

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

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

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

  6. All explanation text must be in <p> tags — check for: bare text, text in <div>, and <br> used to separate text that should be in separate paragraphs;

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 (<span class="ti ti-...">) 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: if multiple elements and text  — 100%, if not — 535px;

  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 ~~~~