Skip to main content

Регламенти до оформлення Концептуального проєкта (blueprint)

В даній статті зібрані загальні вимоги до оформлення Концептуального проєкта (blueprint).

Загальні вимоги до оформлення

  1. Загальна структура документу наступна: 
    1.1. Титульний лист
    Використовується корпоративний шаблон із вказанням юридичної назви клієнта.
    1.2. Зміст
    Має бути зібраний автоматично за допомогою інструментарію Word для зручної навігації користувачів документів.
    1.3. Назва розділу
    Назва розділу починається із порядкового номеру розділу і слів: "Описання вимог до процесу..". Дозволяється групування декількох процесів в один логічний розділ. Також під назвою розділу має міститись таблиця із переліком таких процесів. Наприклад:

    image.png


    1.4.Назва під-розділів
    Назва під-розділів починається із порядкового номеру в розрізі номеру розділу. Зазвичай, під-розділів 3: 
    Загальний опис процесу *Назва процесу із Розділу*
    Схема процесу *Назва процесу із Розділу*
    Опис процесу *Назва процесу із Розділу*
    Для деяких випадків допускається пропуск другого під-розділу (наприклад, при описі звітності).
    1.5. Таблиця кастомізацій/Таблиця доробок
    У разі, якщо по тексту десь зафіксована потреба у доробці чи кастомізації - така доробка чи кастомізація виноситься в окрему таблицю в кінці розділу.
    Формат таблиці кастомізації наступний (допускається відмова від останньої колонки за рішенням тімліда на початку етапу написання документу):

    image.png

    Формат таблиці доробок наступний:

    image.png

    Якщо для зміни в системі не потрібне залучення програміста - це кастомізація. Якщо потрібен - доробка. Кастомізації виконуються на етапі впровадження "Налаштування". Доробки - на етапі "Розробка".

  2. Документ складається українською мовою (якщо перед початком проєкту не було погоджено іншого) із застосуванням чинного правопису на момент написання документу. 

  3. По тексту документу має використовуватись корпоративний шрифт. Який саме - обирається тімлідом і доноситься до команди на початку написання документу.
    Рекомендовані шрифти для тіла документу: 72-Light чи 72-Regular.
    Поточні корпоративні шрифти представлені нижче:

    image.png


  4. Кожне речення починається з великої літери, в кінці речення застосовується крапка. Крапка не використовується в назвах заголовків.
    Підпис процесу на блок-схемі рахується за заголовок і має ті ж правила.
    Наприклад:

    image.png


  5. Нумерація сторінок ведеться справа внизу, починається із другої сторінки.

  6. Колір основного тексту - чорний. Колір заголовків - помаранчевий (відтінок має співпадати у всіх розділах). При необхідності виділення - допускається підкреслення, збільшення шрифту, виділення жирним чи курсивом. 

  7. Максимальний розмір шрифту, який може застосовуватись в документі - 16.

  8. Всі блок-схеми, які використовуються в документі - мають мати растровий формат (!).

  9. Для представлення вигляду не типового документу чи друкованої форми має застосуватись фраза "Приблизний вигляд документу/форми наступний:"