Рекомендации при оформлении ТЗ по ГОСТ. Техническое задание на создание программного обеспечения, сайта или другого программного продукта осуществляется на основании гост 19 или 34 серии
 Скачать 51.05 Kb.
|
|
Пример оформления технического задания по ГОСТ Оформление документа Техническое задание на создание программного обеспечения, сайта или другого программного продукта осуществляется на основании ГОСТ 19 или 34 серии. Оформление документа Техническое задание на создание программного обеспечения, сайта или другого программного продукта осуществляется на основании ГОСТ 19 или 34 серии. В начале работы с документом необходимо подготовить шаблон, отредактировав необходимые параметры и стили в MS Word. Оформление программной документации осуществляется на основании требований ГОСТ 19.106-78. Для формата А4 необходимо задать следующий размер полей страниц: верхнее – 25мм, правое – 10мм, нижнее – 15мм, левое – 20 мм. При выборе альбомного вида страницы размер полей следующий: верхнее – 10мм, правое – 15мм, нижнее – 20мм, левое – 25 мм. Для технического задания на создание программного продукта рамка не наносится. Материалы программного документа располагают в следующей последовательности: титульная часть: лист утверждения (не входит в общее количество листов документа); титульный лист (первый лист документа); информационная часть: аннотация; лист содержания; основная часть: текст документа (с рисунками, таблицами и т.п.); приложения; перечень терминов; перечень сокращений; перечень рисунков; перечень таблиц; предметный указатель; перечень ссылочных документов; перечень символов и числовых коэффициентов; часть регистрации изменений; лист регистрации изменений. Приложения, перечни терминов, сокращений, рисунков и таблиц, предметный указатель, перечни ссылочных документов, символов и числовых коэффициентов выполняются при необходимости. Номер страницы располагается в верхней части страницы по центру, там же следует разместить наименование документа (удобнее это сделать в верхнем колонтитуле). Нумерация страниц должна быть сквозная. Далее следует задать стили для заголовков, списков и основного текста. Лучше всего использовать стандартные стили MS Word (Times New Roman), изменяя их в режиме редактирования, т.к. вновь созданные стили могут некорректно отобразиться при открытии документа на другом рабочем месте. Текст страницы должен не превышать 12px, цвет черный. По поводу выравнивания текста в ГОСТе обязательных требований нет, хотя есть мнение, что текст с выравниванием по левому краю, что удобнее для читать, но визуально выравнивание по ширине смотрится "чище". Для оформления заголовков в документе MS Word следует использовать стили Heading 1, Heading 2 и т.д. Заголовок первого уровня пишется полностью прописными буквами и располагается по центру страницы (14px). Заголовки последующих уровней начинаются с прописной буквы и далее пишутся строчными. Выравнивание заголовков второго и последующих уровней осуществляется по левому краю. В заголовках не допускается перенос слов и точка в конце. Каждый раздел следует начинать с нового листа заголовком первого уровня. Расстояние между заголовком и текстом должно быть равно 10мм.  Текст документа может содержать пункты и подпункты. Для оформления пунктов необходимо использовать нумерованный список вида: 1) a) б) 2) и т.д. Также для наглядности текста технического задания можно использовать таблицы и иллюстрации. Таблицы и иллюстрации могут быть озаглавлены или иметь номер, на который ставиться ссылка в тексте, поэтому при наименовании таблицы или иллюстрации необходимо воспользоваться функцией создания перекрестных ссылок MS Word. Для этого на вкладке "Ссылки" следует выбрать кнопку "Вставить название". В появившейся форме, выбирается формат объекта (таблица, иллюстрация) и задается ее название. Теперь в тексте достаточно выбрать с помощью формы "Вставить ссылку" необходимый объект. Правила оформления таблиц Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а при необходимости, в приложении к документу. Таблицы, за исключением таблиц приложений, нумеруют арабскими цифрами сквозной нумерацией. Например, «Таблица 1». Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например, «Таблица В.1». Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы, разделенных точкой. Например, в разделе 4 номер будет «Таблица 4.3». Название таблицы должно отражать ее содержание, быть точным, кратким. Название состоит из слова «Таблица», номера таблицы и текста. В ГОСТ 2.105-95 не определено использование в названии таблицы дефиса или тире. На практике может использоваться тире, по аналогии использования в названии рисунка тире. Например, «Таблица 5 – Выполняемые работы, содержание и сроки». Точка в конце названия не ставится. Название размещают над таблицей слева. В ГОСТ 2.105-95 в п.п 4.4.3 приведено следущее требование: «На все таблицы документа должны быть приведены ссылки в тексте документа, при ссылке следует писать слово «таблица» с указанием ее номера». На практике слово «таблица» склоняется в тексте по правилам русского языка. Например: «Краткое описание назначения и основных характеристик подсистем ИС МП второй очереди представлено в таблице 1». Если таблица размещается на нескольких страницах, следует отобразить ее заголовок в начале каждой страницы. В ГОСТ 2.105-95 есть необязательное требование в п.4.4.7: «если в конце страницы таблица прерывается и ее продолжение будет на следующей странице, в первой части таблицы нижнюю горизонтальную линию, ограничивающую таблицу, допускается не проводить.». На практике нижнюю горизонтальную линию, проводят, так ее отсутствие ухудшает восприятие таблицы пользователем. Правила оформления иллюстраций К иллюстрациям относятся графические изображения (схемы, графики, фотографии, рисунки). Иллюстрации, за исключением иллюстраций приложений, нумеруются арабскими цифрами, при этом нумерация сквозная. Например: «Рисунок 3». Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например: «Рисунок В.6». Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой. Например, в разделе 5 номер будет «Рисунок 5.2». Допускается не нумеровать мелкие иллюстрации (мелкие рисунки), размещенные непосредственно в тексте и на которые в дальнейшем по тексту нет ссылок. Требования ГОСТ 2.105-95 к расположению: «иллюстрации могут быть расположены как по тексту документа (возможно ближе к соответствующим частям текста), так и в конце его». В ГОСТ 2.105-95 в п. 4.3.1 указано следующее: «при ссылках на иллюстрации следует писать "... в соответствии с рисунком 2" при сквозной нумерации и "... в соответствии с рисунком 1.2" при нумерации в пределах раздела». Название пишется под иллюстрацией в формате «Рисунок 1 – Детали прибора». Интересный факт: если ошибку в бумажном документе замазать и поверх написать исправление черными чернилами, это будет по ГОСТу. ГОСТ 2.105-95 допускает исправления документов в бумажном виде. Об этом гласит п.3.7: «Опечатки, описки и графические неточности, обнаруженные в процессе выполнения документа, допускается исправлять подчисткой или закрашиванием белой краской и нанесением на том же месте исправленного текста (графика) машинописным способом или черными чернилами, пастой или тушью рукописным способом. Повреждения листов текстовых документов, помарки и следы не полностью удаленного прежнего текста (графика) не допускаются». То есть, если вы что-то распечатали и нашли ошибку, то её можно исправить вручную приведенным выше способом. Титульный лист оформляются в соответствии с требованиями ГОСТ 19.104-78. Пример оформления титульного листа показан на рисунке.  |