Стандарт ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению. Объяснение простым языком
Краткое назначение стандарта ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению
ГОСТ 19.404-79 определяет, как правильно писать и оформлять документ «Пояснительная записка». Он нужен на этапах создания эскизного и технического проектов. В записке обязательно рассказывают, что за программа создается, зачем она нужна, какими техническими характеристиками обладает, какую пользу принесет и какими материалами пользовались при разработке.
Область применения стандарта ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению
Этот стандарт применяется при создании программ, комплексов и систем на стадии эскизного и технического проектирования.
Основные термины в стандарте ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению
В стандарте выделяются такие ключевые элементы:
- Пояснительная записка – программный документ, который готовят на этапах эскизного и технического проекта.
- Введение – раздел, где пишут название программы, шифр темы и документы, на основе которых начата разработка (кто их утвердил и когда).
- Назначение и область применения – обязательный раздел пояснительной записки.
- Технические характеристики – обязательный раздел пояснительной записки.
- Ожидаемые технико-экономические показатели – обязательный раздел пояснительной записки.
- Источники, использованные при разработке – обязательный раздел пояснительной записки.
- Информационная часть – аннотация и содержание (их можно делать по желанию).
Краткое содержание стандарта ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению
ГОСТ 19.404-79 входит в Единую систему программной документации (ЕСПД) и описывает требования к пояснительной записке. Документ создают при разработке программ для ЭВМ и систем независимо от их сферы применения.
Общие положения
* Оформляют документ по общим правилам ГОСТ 19.105-78.
* Писать аннотацию и содержание необязательно.
Обязательные разделы пояснительной записки
Записка должна состоять из таких частей:
1. Введение – название программы, тема и официальные документы-основания (с датами и названиями организаций, которые их утвердили).
2. Назначение и область применения – зачем создана программа и где она будет работать.
3. Технические характеристики – параметры и требования к ПО.
4. Ожидаемые технико-экономические показатели – насколько разработка выгодна и целесообразна.
5. Источники, использованные при разработке – литература, стандарты и исходные материалы.
Допущения: если нужно, разработчик может объединять разделы или добавлять новые, исходя из специфики проекта.
Часто задаваемые вопросы (FAQ) по стандарту ГОСТ 19.404-79 «ЕСПД. Пояснительная записка. Требования к содержанию и оформлению»
1. Что представляет собой стандарт ГОСТ 19.404-79 и каково его главное назначение?
Ответ: Это государственный стандарт ЕСПД, который говорит разработчикам, как правильно структурировать и оформлять программный документ – «Пояснительную записку».
2. На каких стадиях разработки программного обеспечения создается данный документ?
Ответ: На самых ранних этапах проектирования – при создании эскизного проекта и технического проекта.
3. На какие виды проектов и сферы деятельности распространяется действие стандарта?
Ответ: На любые программы и системы для компьютеров и вычислительных комплексов, вне зависимости от того, в какой сфере они будут использоваться.
4. Обязательно ли включать в состав пояснительной записки информационную часть?
Ответ: Нет. Аннотацию и содержание можно добавить по желанию, стандартом это не требуются в обязательном порядке.
5. Каковы требования к общей структуре и оформлению документа?
Ответ: Документ оформляется строго по базовому стандарту ЕСПД – ГОСТ 19.105-78.
6. Какие обязательные разделы должна содержать пояснительная записка?
Ответ: Их пять:
1. Введение.
2. Назначение и область применения.
3. Технические характеристики.
4. Ожидаемые технико-экономические показатели.
5. Источники, использованные при разработке.
7. Можно ли изменять стандартный набор разделов (объединять их или добавлять новые)?
Ответ: Да, можно. Если проект нестандартный, разрешено объединять близкие разделы или добавлять новые.
8. Что именно должно быть отражено в обязательном разделе «Введение»?
Ответ: Название программы или шифр темы, а также документы (договоры, приказы), на базе которых стартовала разработка, с указанием дат и утвердивших их ведомств.
9. Какую практическую роль играет пояснительная записка на этапах эскизного и технического проектирования?
Ответ: Она объясняет суть проекта, доказывает, что программу реально создать, оценивает ее пользу и служит основой для дальнейшего написания кода.