13. Документация
К каждому продукту в обязательном порядке необходимо разработать комплект документации. Базово этот список может состоять из следующих документов:
1. Инструкция Пользователя — это инструкция о том, как пользоваться вашим продуктом/сервисом/приложением для конечного пользователя, который непосредственно будет его использовать;
2. Инструкция Администратора — это инструкция для администратора, который будет разворачивать сервис в своей компании, если такое предусмотрено, а также он может заниматься техническим сопровождением пользователей в своей компании, опять же, если вы даёте ему право на доступ к исходному коду;
3. Инструкция Разработчика — это инструкция для разработчиков заказчика, если вы даёте доступ к исходному коду вашего продукта своему заказчику и позволяете вносить туда изменения. Обычно в таком документе может содержаться описание всех основных алгоритмов вашего продукта, переменных, функций, которые используются, и т. д.;
4. API — документ, описывающий как пользоваться модулем API вашего продукта и какие данные можно получить из вашего продукта с помощью API.
Так же этот список могут пополнить иные документы, которые будут содержать описания каких-то специфических модулей, которые есть в вашем продукте. Такие описания должны содержать информацию о том, как пользоваться этим модулем, зачем он вообще нужен, как его развернуть, как получить из него информацию и как его поддерживать. Все подобные документы либо
Кіру не тіркелу пікір қалдыру үшін