документация софтуер, потребителска документация, документация - компанията

Документация за софтуера - това документите, придружаващи софтуера (SW) - програма или софтуерен продукт. Тези документи описват как работи програмата и / или как да го използват.

Документацията е важна част от разработката на софтуер, но често се пренебрегва.

Има четири основни типа документация за софтуер:

• архитектура / дизайн - преглед на софтуера, включително и работната среда, както и описание на принципите, които трябва да се използва при създаването на софтуер
• технически - документацията на код, алгоритми, интерфейси, на API
• потребител - ръководство за крайните потребители, системни администратори и други служители
• маркетинг

Архитектура / конструкторска документация

Проектна документация обикновено описва продукта като цяло. Без да се описва как се използва нещо, то вероятно отговаря на въпроса "Защо?" Например, в документацията по проекта програмист може да се опише обосновка защо тези структури са организирани по този начин. Описва причините, поради които всеки клас има за цел по определен начин, да се изправя модели, в някои случаи, дори и като се има предвид идеята за това как тя ще бъде възможно да се извърши подобрения в бъдеще. Нищо от това не е включена в техническата документация или ръководство, но това е наистина важно за проекта.

техническа документация

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

Тази документация е много ясно изразен технически характер и се използва предимно за откриване и описание на API, структури от данни и алгоритми.

документация за потребителя

За разлика от техническата документация, фокусирани върху кода и как работи, само документацията за потребителя описва как да използвате програмата.

Ако продуктът е софтуерна библиотека, документация за потребителя и документация за кода на са много близки, почти равностойни. Но като цяло, не е така.

Обикновено документацията за потребителя е ръчен, която описва всяка функция на програмата, както и стъпки, които можете да следвате, за да използвате тази функция. Добър потребителска документация отива една стъпка по-далеч и осигурява инструкции какво да правят в случай на проблеми. Важно е, че документацията не е подвеждащо и е от значение. Ръководството трябва да има ясна структура; много полезно, ако има индекс хоризонтален субект. Логическата последователност и простота също са важни.

Има три подхода за организиране на документацията за потребителя. Ръководство за начинаещи (инж. Tutorial), най-полезно за нови потребители, постоянно се преследва от редица стъпки, които се използват за извършване на каквито и да било типични задачи. Тематичен подход, при който всяка глава на ръководството е посветен на определена тема някои по-подходящи за подобряване на потребителя. В последния, третия подход, екипът или задача са организирани в азбучен указател - често добре приети от напреднали потребители, които са запознати с това, което търсите. оплаквания от потребители обикновено са свързани с факта, че документацията обхваща само един от тези подходи, и затова е подходящ за само един клас потребители.

В много случаи, разработчици на софтуер ограничен набор от документация за потребителя е само в помощната система (инж. Онлайн помощ), съдържащ информация за справка относно команди или елементи от менюто. Работата по подготовката на нови потребители и подкрепата на подобряване на потребителя се предава на частните издатели, често предоставя значителна помощ на разработчиците.

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

1. възбуди интерес към продукта от страна на потенциалните потребители
2. ги информира за това, което прави продукта, така че да отговарят на очакванията им, така че те ще получат
3. за да обясни позицията на продукта в сравнение с конкурентните решения

Един добри маркетингови практики - осигуряване на лозунг - обикновен закачливите фрази, които да представят това, което искаме да предадем на потребителя, както и характеризиране на усещането. което създава продукт.

Това често се случва, че кутията на продукта и други маркетингови материали дават по-ясна представа за възможностите и начините за използване на програмата, отколкото нещо друго.