Общи инструкции за писане на HELP страници

Общи условия

Не работите сами! Това е работа в екип. Съобразявайте се с екипа!

Пишете така, че и другите да разбират какво сте писали. Описвайте добре всяко поле, защото друг или вие след време няма да можете да се ориентирате какво гледате или за какво се отнася хелпа!

Когато описвате структура в системата използвайте символа “ > „ за описание на пътеката до интерфейса – например Финанси > Настройки финанси > Данъци

Създаване на хелп в AWF

  1. Когато създавате линк задължително попълвате полето Interface name СМИСЛЕНО! Така че когато след вас някой го погледне да разбере хелпа закъде се отнася!
    1. Грешно – Продажба
    2. Правилно – P&S > Продажби > Нова продажба
  2. Когато реферирате към страница проверете дали нейното ID (https://docs.prim.io/bg/?page_id=1507) вече не съществува. Ако съществува проверете дали има смисъл да създавате линка или вече съществуващия не е описан добре. Имайте впредвид че е възможно и смислено няколко различни интерфейса в системата да ползват общ хелп в WP!

Създаване на хелп в WordPress

Всеки модул в WP има структура:

  • Описание, документи и операции
  • Оперативна дейност
  • Справки
  • Настройки

Описание на документ

Когато описвате какъвто и да е документ той трябва да има като минимум следните страници – Общо описание, Създаване, Редакция, Добавяне/редакция на ред, Досие. Всичките трябва да се намират в следната примерна структура:

  • Модул
    • Описание, документи и операции
      • Документ (общо описание)
        • Създаване
        • Редакция
        • Добавяне на ред
        • Досие

Важно: не всеки тип документ има смисъл да се описва толкова детайлно! За доста типове документи може да се използва общото описание от Описание на системата > Досие на документ и Описание на системата > Документи и обекти

Документи за детайлно описание

Описание на интерфейс в Оперативна дейност на модула

Обикновено това са списъци с филтър и резултат. Описва се как работи фитъра. Описва се какво показва резултата. Ако резултата е в повече от един таб се описва всеки таб. Ако в резултата има възможности за действия се описват какви действия могат да се правят с резултата и се реферира към съответните хелп страници (най вероятно се намират някъде в Модул >Описание, документи и операции) Ако в резултата има линкове към досиета на документ/обекти се описва до каква свързана информация може да се стигне от него.

Пример: интерфейс Продажби в P&S > Продажби хелп страницата трябва да има следната структура:

  1. Общо описание и предназначение
  2. Филтър –
    1. Как работи – общо описание
    2. радиогрупата Документи/Редове/Артикули как променя резултата
    3. чекбоксовете как показват/крият колони
    4. специално да се обясни филтър по Статус
  3. Резултат Документи
    1. Какво показва – общо описание
    2. Икона за бърз преглед на редовете на документа
    3. Достъп до досието на клиента
    4. Описание на всички видове суми/цифри и какво показват
    5. Описание на оцветяването и условията за това
    6. Достъп до досието на документа
  4. Резултат Редове
    1. Какво показва – общо описание
    2. Достъп до досието на клиента
    3. Достъп до досието на артикула
    4. Достъп до досието на документа
    5. Описание на всички видове суми/цифри и какво показват
  5. Резултат Артикули
    1. Какво показва – общо описание
    2. Достъп до досието на артикула
    3. Описание на всички видове суми/цифри и какво показват
  6. Възможни действия от екрана
    1. Бутони за създаване на нов документ

Важно: не всеки интерфейс има смисъл да се описва толкова детайлно! За доста интерфейси може да се използва общото описание от Описание на системата > Списъци

Интерфейси за детайлно описание

Създаване на хелп в WordPress Tips & Tricks

ReUse на съдържание:

  • За всички деца:
  • За парента:
  • За конкретна страница:

Визуално оформление на страници

Заглавие на страницата

H3- подзаглавие на описваната функционалност

Скрийншот
class=
Всеки скрийншот посочва ограждане с червена линия на обясняваната фукционалност и червен номер в дясната страна на ограждението. Обясненията по всеки скрийншот са след него!

H3 описание на посочената цифра (1)

Описание

H3 описание на посочената цифра (2)

Описание

За примери и важни уточнения да се използват цитати.
Редакция