Документацию на программное обеспечение (ПО) разрабатывают, опираясь на те или иные стандарты. В нашей стране чаще всего используют ГОСТ или ГОСТ Р. Стандарты регламентируют не только оформление и содержание документов, но и процессы разработки, сопровождения, изготовления и эксплуатации ПО. Как правило, документацию на ПО и на автоматизированные системы разрабатывают в соответствии с единой системой программной…
Разработчики документации регулярно сталкиваются с такими вопросами: Какой тип списка выбрать? Сколько уровней вложенности может быть у списков в документации? Как маркировать или нумеровать уровни многоуровневых списков? 1. Ключевые моменты В качестве основных целей составления технического документа можно выделить: Список – это не совсем верный термин. Правильный термин: перечисление. Перечисление – это структурный элемент документа.…
В статье рассматриваются следующие основные вопросы: Каких целей достигает хорошо написанный документ? Что позволяет считать документ хорошим? Как составить хороший документ? Каких целей достигает хорошо написанный документ? В качестве основных целей составления технического документа можно выделить: Обучение конечных пользователей и сотрудников продукту компании. Формирование справочных материалов и баз знаний по продукту компании. Снижение нагрузки на…
В мире IT используются следующие термины: регистрация; идентификация; аутентификация; авторизация; вход в систему. Некоторые разработчики документации путают эти термины. Поэтому документация получается не очень высокого качества. Давайте выясним, чем отличаются эти термины. Регистрация Сначала выполняется регистрация – создание учетной записи пользователя. Пользователь открывает форму регистрации и заполняет данные о себе (в том числе логин и…
Часто случается, что представить информацию в документе эффективнее схемой, чем текстом. Схема хорошо подходит, когда нужно передать основную идею устройства, предмета или процесса без соблюдения масштаба. Информативность же схемы зависит от множества факторов. Главное Схема должна быть понятна без чтения сопроводительного текста. Схема или диаграмма должна отображать только одно и очень конкретное явление. Например: Не…