Читать «ИНФОРМАЦИОННАЯ ТЕХНОЛОГИЯ. РУКОВОДСТВО ПО УПРАВЛЕНИЮ ДОКУМЕНТИРОВАНИЕМ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ» онлайн - страница 6
ГОССТАНДАРТ РОССИИ
Документация продукции должна включать в себя материалы для следующих типов читателей:
пользователей, которые вводят данные, восстанавливают информацию и решают задачи с помощью программного обеспечения;
операторов, которые «прогоняют» программное обеспечение на вычислительной системе;
сопровождающих программистов, которые сопровождают, модернизируют или изменяют программное обеспечение.
Документация продукции может также включать в себя:
руководства и материалы для руководителей, которые следят за использованием программного обеспечения;
вспомогательные материалы, освещающие возможности программной продукции и уточняющие ее функции, условия эксплуатации и т. д.;
общую информацию, описывающую программную продукцию для всех заинтересованных лиц.
Типовые документы продукции включают в себя:
учебные руководства;
справочные руководства и руководства пользователя;
руководства по сопровождению программного обеспечения;
брошюры и информационные листовки, посвященные продукции.
7.2.3
Документы создают на основе информации управления проектом, такой как:
графики для каждой стадии процесса разработки и отчеты об изменениях графиков;
отчеты о согласованных изменениях программного обеспечения;
отчеты о решениях, связанных с разработкой;
распределение обязанностей.
Данная документация обеспечивает информацию, относящуюся, с точки зрения руководства, к долговечности продукции.
7.3 Определение качества документов
Руководители должны выбирать стандарты, распространяющиеся на уровень качества, соответственно различным типам документов и различным типам проектов и должны определять, как это качество будет достигнуто и поддержано.
Понятия качества, применимые к содержанию, структуре и представлению документации:
1) качество содержания можно измерять в элементах точности, полноты и ясности;
2) качество структуры можно измерять легкостью, с которой читатель имеет возможность определить местоположение информации;
3) качество представления должно соответствовать типу проекта. Например, руководство пользователя может иметь форму набора машинописных страниц, скрепленных вместе, или может быть типографской книгой с обширными иллюстрациями, созданной специалистом по графике.
7.4 Определение форматов документов
Стандартизованные форматы документов важны для контроля качества документов, для читаемости документов и для облегчения их сопровождения.
Информация может быть представлена в различных форматах. Проектные спецификации, например, могут быть записаны на установленных бланках. Обучение пользователя можно осуществить посредством учебных программ в классах или учебных конспектов и консультаций.
Форматы документов могут различаться от проекта к проекту. Они зависят от таких факторов, как объем проекта, аудитория, для которой предназначены документы, количество установленных стадий и бюджет документирования.
В проектируемых форматах должны быть учтены соображения о том, будут ли документы переводить для международного распространения.
