Типи програмної документації

Зміст:

Anonim

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

Пропозиція

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

ТЕО

Техніко-економічне обґрунтування зазвичай відбувається на початку проекту. Цей етап визначає, чи задовольняє виробниче підприємство виробничі потреби замовника. Результат вивчення обґрунтованості вирішує, чи піде проект чи ні.

Аналіз вимог

Аналіз вимог забезпечує засоби перекладу бізнес-вимог в автоматизовані програмні рішення. Зовнішній консультант або керівництво компанії зазвичай виконує це завдання. Вимоги перетворюють бізнес-вимоги на фактичні специфікації для обладнання, програмного забезпечення та компонентів.

Дизайнерські документи

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

Документи кодування

Документи кодування стосуються фактичного вихідного коду, який використовується для програмування програмного забезпечення. Код може бути написаний будь-якою кількістю доступних комп'ютерних мов, включаючи Java, C ++, PHP і сотні інших мов комп'ютера залежно від використовуваної системи.

Тестування документів

Команди тестування та розробники створюють тестові документи на різних етапах життєвого циклу програмного забезпечення. Розробники створюють документи для тестування блоків для власного коду. Команда тестування або інші люди, не пов'язані безпосередньо з кодом, здійснюють тестування інтеграції та тестування бізнес-вимог.

Посібники користувача та маркетинг

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

Ліцензії на програмне забезпечення

Видача ліцензій на програмне забезпечення робить використання програмного забезпечення законним, наскільки це стосується кінцевого користувача. Користувачі використовують програмне забезпечення згідно з умовами ліцензії на програмне забезпечення, видану авторською компанією. Не всі програми мають строгі умови ліцензування, і це особливо вірно у випадку з відкритим кодом. Як правило, програмні системи мають певну форму ліцензійного документа, що визначає, як і де може використовуватися програмне забезпечення.