вівторок, 10 лютого 2009 р.

Навіщо документувати програмні продукти: користь для клієнта й команди

Документування допомагає не лише користувачам, а й розробникам. У первинній нотатці я зібрав дев’ять аргументів; нижче їх уточнено без обіцянок гарантованого комерційного ефекту.

  1. Підготовку документації можна погодити як окремий оплачуваний обсяг робіт.
  2. Пояснюючи систему, автор краще осмислює її логіку.
  3. Записаний матеріал дає змогу відновити знання згодом.
  4. Відкрита документація може знайомити потенційних користувачів із продуктом, але не гарантує замовлень.
  5. Вимоги до інформації про продукт потрібно враховувати відповідно до застосовних норм і умов його постачання.
  6. Опис процесів допомагає знаходити прогалини та підвищувати якість роботи.
  7. Посилання на конкретну інструкцію зменшує кількість повторних пояснень.
  8. Добре структурований посібник полегшує навчання.
  9. З документації можна зрозуміти призначення й можливості рішення ще до його вибору.

Уточнення правового аргументу

У первинному тексті була категорична теза, що кожен продукт за законом обов’язково має постачатися з документацією. Без визначення виду продукту, правовідносин і конкретної норми таке узагальнення недостатнє.

Наприклад, стаття 15 Закону України № 1023-XII стосується права споживача на інформацію про продукцію й передбачає різні способи її доведення. Це не тотожне універсальній вимозі окремого однакового посібника до будь-якого програмного продукту. Офіційний текст закону.

Немає коментарів:

K2 Chat — навіщо бізнесу ще один месенджер, особливо під час війни?

«Де файл?» — «У чаті». — «У якому із семи?» Знайома ситуація? Коли робочі домовленості розпорошені між месенджерами, команді складніше знах...