Документація на програмне забезпечення

Документація на програмне забезпечення - друковані керівництва користувача, діалогова (оперативна) документація та довідковий текст, що описують як користуватися програмним продуктом ^[1].

Документ - елемент документації: цільова інформація, призначена для конкретної аудиторії, розміщена на конкретному носії (наприклад, в книзі, на диску, в короткій довідкової карті) в заданому форматі ^[1].

Програмний документ - документ, що містить в залежності від призначення дані, необхідні для розробки, виробництва, експлуатації, супроводу програми або програмного засобу ^[2].

1. Типи документації

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

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

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

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

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

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

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

Часто при складанні технічної документації використовуються автоматизовані засоби - генератори документації, такі як Doxygen, javadoc, NDoc та інші. Вони отримують інформацію з спеціальним чином оформлених коментарів у вихідному коді, і створюють довідкові керівництва в якомусь форматі, наприклад, у вигляді тексту або HTML.

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

1.3. Користувацька документація

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

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

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

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

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

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

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

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

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

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

Примітки