33 Проектная документация и системы стандартов

Единая система программной документации (ЕСПД) — комплекс государственных стандартов Российской Федерации, устанавливающих взаимосвязанные правила разработки, оформления и обращения программ и программной документации. В стандартах ЕСПД устанавливают требования, регламентирующие разработку, сопровождение, изготовление и эксплуатацию программ, что обеспечивает возможность:

• унификации программных изделий для взаимного обмена программами и применения ранее разработанных программ в новых разработках;

• снижения трудоемкости и повышения эффективности разработки, сопровождения, изготовления и эксплуатации программных изделий;

• автоматизации изготовления и хранения программной документации.

Сопровождение программы включает анализ функционирования, развитие и совершенствование программы, а также внесение изменений в нее с целью устранения ошибок.

Поскольку ЕСПД представляет собой набор ГОСТов, в настоящее время её применение на территории РФ носит только рекомендательный характер, то есть ЕСПД применяется на добровольной основе (если иное не предусмотрено договором, контрактом, отдельными законами, решением суда и т.п.)

Еди́ная систе́ма констру́кторской документа́ции (ЕСКД)^[1] — комплекс государственных стандартов, устанавливающих взаимосвязанные правила, требования и нормы по разработке, оформлению и обращению конструкторской документации^[2], разрабатываемой и применяемой на всех стадиях жизненного цикла изделия (при проектировании, разработке, изготовлении, контроле, приёмке, эксплуатации, ремонте, утилизации).

Основное назначение стандартов ЕСКД состоит в установлении единых оптимальных правил, требований и норм выполнения, оформления и обращения конструкторской документации, которые обеспечивают^[1]:

1. применение современных методов и средств на всех стадиях жизненного цикла изделия;

2. возможность взаимообмена конструкторской документацией без её переоформления;

3. оптимальную комплектность конструкторской документации;

4. механизацию и автоматизацию обработки конструкторских документов и содержащейся в них информации;

5. высокое качество изделий;

6. наличие в конструкторской документации требований, обеспечивающих безопасность использования изделий для жизни и здоровья потребителей, окружающей среды, а также предотвращение причинения вреда имуществу;

7. возможность расширения унификации и стандартизации при проектировании изделий и разработке конструкторской документации;

8. возможность проведения сертификации изделий;

9. сокращение сроков и снижение трудоёмкости подготовки производства;

10. правильную эксплуатацию изделий;

11. оперативную подготовку документации для быстрой переналадки действующего производства;

12. упрощение форм конструкторских документов и графических изображений;

13. возможность создания и ведения единой информационной базы;

14. возможность гармонизации стандартов ЕСКД с международными стандартами (ИСО, МЭК) в области конструкторской документации;

15. возможность информационного обеспечения поддержки жизненного цикла изделия.

Стандарты ЕСКД распространяются на изделия машиностроения и приборостроения. Область распространения отдельных стандартов расширена, что оговорено во введении к ним. Поскольку ЕСКД представляет собой наборГОСТов, в настоящее время её применение на территории РФ носит только рекомендательный характер, то есть ЕСКД применяется на добровольной основе (если иное не предусмотрено договором, контрактом, отдельными законами, решением суда и т.п.)

Руководство пользователя (англ. user guide или user manual), руководство по эксплуатации, руководство оператора — документ, назначение которого — предоставить людям помощь в использовании некоторой системы. Документ входит в состав технической документации на систему и, как правило, подготавливается техническим писателем.

1. Большинство руководств пользователя помимо текстовых описаний содержит изображения. В случае программного обеспечения, в руководство обычно включаются снимки экрана, при описании аппаратуры — простые и понятные рисунки или фотографии. Используется стиль и язык, доступный предполагаемой аудитории, использованиежаргона сокращается до минимума либо подробно объясняется. Типичное руководство пользователя содержит:

2. Аннотацию, в которой приводится краткое изложение содержимого документа и его назначение

3. Введение, содержащее ссылки на связанные документы и информацию о том, как лучше всего использовать данное руководство

4. Страницу содержания

5. Главы, описывающие, как использовать, по крайней мере, наиболее важные функции системы

6. Глава, описывающая возможные проблемы и пути их решения

7. Часто задаваемые вопросы и ответы на них

8. Где ещё найти информацию по предмету, контактная информация

9. Глоссарий и, в больших документах, предметный указатель

Все главы и пункты, а также рисунки и таблицы, как правило, нумеруются, с тем, чтобы на них можно было сослаться внутри документа или из другого документа. Нумерация также облегчает ссылки на части руководства, например, при общении пользователя со службой поддержки.

Единая Система Технологической Документации (ЕСТД) — комплекс стандартов и руководящих нормативныхдокументов, устанавливающих взаимосвязанные правила и положения по порядку разработки, комплектации, оформлению и обращению технологической документации, применяемой при изготовлении и ремонте изделий.

Основные технологические документы содержат различную информацию:

• о комплектующих составных частях изделия и применяемых материалах;

• о действиях, выполняемых исполнителями при проведении технологических процессов и операций;

• о средствах технологического оснащения производства;

• о наладке средств технологического оснащения и применяемых данных по технологическим режимам;

• о расчете трудозатрат, материалов и средств технологического оснащения;

• о технологическом маршруте изготовления и ремонта.

Основные технологические документы используют, как правило, на рабочих местах. Вспомогательные технологические документы разрабатывают с целью улучшения и оптимизации организации работ по технологической подготовке производства. Производные технологические документы применяют для решения задач, связанных с нормированием трудозатрат, выдачей и сдачей материалов, полуфабрикатов и комплектующих изделий.