Документація на програмне забезпечення, призначена для користувача документація, документування - компанія

Документація на програмне забезпечення - це документи, разом із програмним забезпеченням (ПЗ) - програму або програмний продукт. Ці документи описують те, як працює програма і / або те, як її використовувати.

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

Існує чотири основних типи документації на ПЗ:

  • архітектурна / проектна - огляд програмного забезпечення, що включає опис робочого середовища і принципів, які повинні бути використані при створенні ПЗ
  • технічна - документація на код, алгоритми, інтерфейси, API
  • призначена для користувача - керівництва для кінцевих користувачів, адміністраторів системи та іншого персоналу
  • маркетингова

Архітектурна / проектна документація

Проектна документація зазвичай описує продукт в загальних рисах. Чи не описуючи того, як що-небудь буде використовуватися, вона швидше за відповідає на питання «чому саме так?» Наприклад, в проектному документі програміст може описати обгрунтування того, чому структури даних організовані саме таким чином. Описуються причини, чому який-небудь клас сконструйований певним чином, виділяються патерни, в деяких випадках навіть даються ідеї якомога буде виконати поліпшення в подальшому. Нічого з цього не входить в технічну або документації для користувача, але все це дійсно важливо для проекту.

Технічна документація

Це саме те, що мають на увазі під терміном документація більшість програмістів. При створенні програми, одного лише коду, як правило, недостатньо. Повинен бути наданий певний текст, що описує різні аспекти того, що саме робить код. Така документація часто включається безпосередньо в вихідний код або надається разом з ним.

Подібна документація має сильно виражений технічних характер і в основному використовується для визначення і опису API, структур даних і алгоритмів.

Призначена для користувача документація

На відміну від технічної документації, сфокусованої на коді і тому як він працює, призначена для користувача документація описує лише те, як використовувати програму.

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

Зазвичай, призначена для користувача документація вдає із себе керівництво користувача, яке описує кожну функцію програми, а також кроки, які потрібно виконати для використання цієї функції. Хороша для користувача документація йде ще далі і надає інструкції про те що робити в разі виникнення проблем. Дуже важливо, щоб документація не вводити в оману і була актуальною. Керівництво повинно мати чітку структуру; дуже корисно, якщо є наскрізний предметний покажчик. Логічна зв'язність і простота також мають велике значення.

Існує три підходи до організації користувальницької документації. Довідник з основних функцій (англ. Tutorial), найбільш корисне для нових користувачів, послідовно проводить по ряду кроків, службовців для виконання будь-яких типових задач. Тематичний підхід, при якому кожна глава керівництва присвячена якійсь окремій темі, більше підходить для удосконалюються користувачів. В останньому, третьому підході, команди або завдання організовані у вигляді алфавітного довідника - часто це добре сприймається просунутими користувачами, які добре знають, що вони шукають. Скарги користувачів зазвичай ставляться до того, що документація охоплює тільки один з цих підходів, і тому добре підходить лише для одного класу користувачів.

У багатьох випадках розробники програмного продукту обмежують набір користувальницької документації лише вбудованою системою допомоги (англ. Online help), що містить довідкову інформацію про команди або пунктах меню. Робота з навчання нових користувачів і підтримки удосконалюються користувачів перекладається на приватних видавців, часто надають значну допомогу розробникам.

Маркетингова документація

  1. підігріти інтерес до продукту у потенційних користувачів
  2. інформувати їх про те, що саме робить продукт, з тим щоб їх очікування збігалися з тим що вони отримають
  3. пояснити положення продукту в порівнянні з конкуруючими рішеннями

Одна з хороших маркетингових практик - надання слогана - простий запам'ятовується фрази, що ілюструє те що ми хочемо донести до користувача, а також характеризує відчуття. яке створює продукт.

Часто буває так, що коробка продукту та інші маркетингові матеріали дають більш ясну картину про можливості та способи використання програми, ніж все інше.

Схожі статті