Техническая документация
-
Определение технической документации
- Техническая документация описывает использование, функциональность и архитектуру продуктов, систем и услуг.
-
Классы технической документации
- Включает патенты, технические характеристики, методы испытаний, стандарты производства и системные требования.
- Включает системные требования, системную архитектуру, проектные документы и данные.
-
Стандартизация технической документации
- Большинство классов документации не стандартизированы по формату, содержанию и структуре.
- ISO разрабатывает стандарты для унификации документации.
-
Стандарты ISO
- ISO 15787, ISO 3098, ISO 10209, ISO 2162, ISO 5457, ISO 6433 охватывают различные аспекты технической документации.
-
Регулирование медицинской документации ЕС
- Регламент ЕС по медицинским изделиям требует наличия технической документации для медицинских устройств.
- В приложениях II и III описаны требования к содержанию и постмаркетинговому надзору.
-
Форматы для исходных данных
- Используются различные архитектуры документирования, включая DITA, Документальную книгу, S1000D и Реструктурированный текст.
-
Системы документирования
- Существуют различные платформы и системы документирования, каждая со своими особенностями и потребностями пользователей.
-
Дополнительные темы
- Упомянуты другие связанные темы, такие как управление документооборотом, разработка метода, сетевая документация и техническое редактирование.