Для эффективного управления документированием программного обеспечения, важно осознавать различные функции, выполняемые документацией.
Программную документацию можно рассматривать как имеющую шесть основных функций:
1) информация для управления (см. 5.1);
2) связь между задачами (см. 5.2);
3) обеспечение качества (см. 5.3);
4) инструкции и справки (см. 5.4);
5) сопровождение программного обеспечения (см. 5.5);
6) исторические справки (см. 5.6).
Во время разработки программного обеспечения администрации необходимо оценивать ход работы, возникающие проблемы и вероятности развития процесса. Периодические отчеты, согласно которым проверяют ход работ по графику и представляют планы на следующий период, обеспечивают контрольные механизмы и обзор проекта.
Большинство проектов разработки программного обеспечения разделяется на задачи, зачастую выполняемые различными группами.
В типовом варианте:
специалисты в предметной области начинают проект;
аналитики формулируют требования к системе;
проектировщики разрабатывают системный и программный проекты;
специалисты по изданиям создают пользовательскую документацию в соответствии со стратегией и стандартами по документированию;
специалисты по обеспечению качества и ревизоры оценивают общую полноту и качество функционирования программного обеспечения;
сопровождающие программисты улучшают эксплуатируемое программное обеспечение и разрабатывают его изменения или расширения.
Этим людям необходимы средства общения друг с другом, обеспечивающие информацию, которую можно, при необходимости, воспроизводить, распространять и на которую можно ссылаться.
Большинство методологий разработки программного обеспечения устанавливают официальные документы для связи между задачами. Например, аналитики представляют официальные спецификации требований для проектировщиков, а проектировщики выдают официальные проектные спецификации для программистов.
Требуется документация разработки и документация продукции для выполнения задач, связанных с обязанностями по обеспечению качества программного обеспечения.
Документация, требующаяся операторам, пользователям, руководителям и другим заинтересованным лицам для того, чтобы понимать и использовать программную продукцию.
Сопровождающим программистам требуется детальное описание программного обеспечения, такое, чтобы они могли локализовать и корректировать ошибки и модернизировать или изменять программное обеспечение соответствующим образом.
Документация, требуемая в качестве исторической справки по проекту. Данная документация может помочь в переносе и переводе программного обеспечения в новое окружение.