Уровни качества документирования
-
40 мин
Комплект документации для одного и того же программного продукта может существенно различаться в зависимости от бизнес-целей: состав материалов, целевая аудитория, глубина детализации, требования к актуальности, а также соответствие правилам — ГОСТы, отраслевые стандарты, требования регуляторов, внутренние стайлгайды. Более того, на проектах могут применяться свои критерии оценки качества документации: сроки подготовки, оформление, полнота содержания, актуальность и другие параметры.
В этом докладе я покажу, как определение необходимого уровня качества напрямую влияет на сроки и трудозатраты. Мы обсудим, какие параметры следует учитывать в первую очередь:
-
необходимость строгого соответствия ГОСТам,
-
требования к иллюстрациям и подписям,
-
кликабельность перекрёстных ссылок
и многое другое.
Также поговорим о том, как выбранный уровень качества определяет не только объём работы, но и квалификацию специалистов, которые должны быть привлечены к проекту.