4.7 Требования к документированию

Документация системы должна содержать:

- Документация разработчика:

- описание API-функций, предоставляемых разрабатываемой системой;

- описание классов, их свойств и методов программной реализации системы;

- примеры использования программных классов системы;

- Документация пользователя:

- описание выполняемых системой функций;

- описание вариантов использования системы;

- примеры использования системы;

- Документация администратора системы:

- описание методов и протоколов доступа к консолям администрирования компонентов системы: операционная система, база данных, web-сервер и т.д.;

- описание требований системы к техническому обеспечению;

- описание требования системы к программному обеспечению;

- данные разработчика;

- Документация персонала системы:

- описание функций программного обеспечения, производящего загрузку информационного наполнения системы;

- описание формата входных данных системы;