Ілюстрований каталог деталей і складальних одиниць за стандартом s1000d
Загальні питання документування
Технічна комунікація: до постановки проблеми
Документування систем і ІТ-інфраструктур
ГОСТ 34
Навіщо потрібні ГОСТ 19 і ГОСТ 34
Автоматизована система з точки зору ГОСТ 34
Автоматизована система з точки зору ГОСТ 34. Продовження
A Ghost of the GOST
Як присвоїти документу «код по госту»
документування інфраструктур
Документування ІТ-інфраструктури організації
документування процесів
Розробка нормативної документації: навіщо вони потрібні і що собою являють?
Коли необхідно починати регламентацію діяльності і перехід до регулярного менеджменту?
управління документуванням
Підхід до оцінки термінів створення технічної документації
Методика і стиль викладу
Яким має бути керівництво користувача
Як світ влаштований? Концептуальний розділ керівництва користувача
Як писати документацію по-англійськи?
інструментарій
Розробка технічної документації на основі єдиного джерела
Писати bat-файли може кожен!
MadCap Flare: система для розробки технічної документації на основі єдиного джерела
Ілюстрований каталог деталей і складальних одиниць за стандартом S1000D
Microsoft Word
Microsoft Word для технічного письменника
Рекомендації по системі стилів в шаблонах для технічної документації
DITA
Технологія DITA: огляд можливостей і основні переваги
Документування вимог за допомогою DITA
DocBook / XML
DocBook / XML: відкрита платформа для розробки технічної документації
Налаштування оформлення вихідних документів в DocBook / XML
Налаштування FO-процесорів для виведення символів кирилиці в середовищі Microsoft Windows
CMDB Docs
Діаграми «стимул-реакція» - альтернатива традиційним моделям бізнес-процесів
Кадрові питання документування
Хто такі технічні письменники?
Технічний письменник. Базові компетенції фахівця
Технічний редактор в великому світі: спеціальність і професія >>
стандартизація
Проект ГОСТу на стиль викладу
ANSI Z535.6 - стандарт на попереджувальні врізки в технічній документації
заходи
Конференція «Документування сьогодні»
Введення в DITA. запис вебінару
Переклад
А. В. Клименко. Ремесло перекладу >>
HAT і CAT
інше
Як написати курсову і не тися по самі вуха
Гуманна робота в програмі Microsoft Excel
Як переконливо скласти кошторис, план або звіт з чисельними даними
Походження та роль специфікації S1000D
Якщо говорити зовсім коротко, то специфікація S1000D - це міжнародний стандарт на технічну документацію в аерокосмічній галузі. Вона не є стандартом ISO, однак у багатьох країнах, особливо технологічно розвинених, використовується як стандарт де-факто, причому не тільки в аерокосмічній галузі, а й у інших областях, де потрібно збирати, систематизувати і публікувати великі обсяги технічної інформації, - наприклад, в суднобудуванні і автомобілебудуванні.
В даний час над специфікацією працюють три організації, кожна з яких представляє собою велике галузеве об'єднання:
- Європейська асоціація галузей аерокосмічної і оборонної промисловості (AeroSpace and Defence Industries Association of Europe - ASD);
- Американська асоціація підприємств аерокосмічної галузі (Aerospace Industries Association of America - AIA);
- Асоціація підприємств повітряного транспорту США (Air Transport Association - ATA).
Деякі ключові поняття S1000D
Ілюстрований каталог деталей і складальних одиниць також вважається технічною публікацією, незалежно від того, надрукований він на папері як брошура (книга) або є гіпертекст, що існує тільки в електронному вигляді.
Допускаючи різні типи технічних публікацій, специфікація пред'являє досить суворі єдині деталізовані вимоги до їх структурі і оформленню. Жорсткість вимог може здивувати вітчизняного фахівця з технічної документації, яка звикла до того, що західні стандарти зазвичай бувають більш розпливчастими і ліберальними, ніж українські.
Залежно від свого змісту модулі даних підрозділяються за типами - наприклад, модуль ілюстрованого каталогу і модуль схеми електрообладнання належать до різних типів. Для модулів кожного типу визначено склад даних, які можуть або повинні там бути присутнім, причому вказується, які дані є обов'язковими, а які факультативними. Для модуля ілюстрованого каталогу інформація про деталі в структурованому вигляді - це обов'язкові дані, а графічні зображення деталей і інформацію про зонах, в яких розташовані деталі, - факультативні дані.
Ілюстрований каталог деталей і складальних одиниць по специфікації S1000D
У версії 4.0 специфікації S1000D ілюстровані каталоги деталей і складальних одиниць регламентовані розділом 5.3.1.3 (можливо, в наступних версіях це зміниться).
Основні функції, які виконує ілюстрований каталог деталей і складальних одиниць, відповідно до специфікації такі:
- ідентифікація виробів, їх складових частин та ЗІП об'єкта документування (літака, судна і т.п.) в рамках проекту;
- надання відомостей про взаємозв'язках між складовими частинами вироби (входження деталей у вузли об'єкта, взаємозамінність деталей і ін.);
- надання відомостей про замовлення / постачання деталей і складальних одиниць (наприклад, кількість виробів в одиниці постачання - комплекті, ящику і т. п. одиниці виміру для одиниці постачання, відмітка про особливі умови зберігання виробу).
Специфікацією визначені наступні властивості ілюстрованого каталогу деталей і складальних одиниць:
- типи модулів даних, що входять в каталог;
- вимоги до структури каталогу;
- оформлення каталогу для друку;
- оформлення сторінок електронного каталогу;
- схеми модулів даних каталогу на мові XML;
- порядок реєстрації деталей, включених в каталог.
Малюнок 1. Структура ілюстрованого каталогу деталей і складальних одиниць.
На рис. 2 показана структура XML-файлів ілюстрованого каталогу деталей і складальних одиниць.
Малюнок 2. Структура XML-файлів ілюстрованого каталогу деталей і складальних одиниць
На рис. 3 показана структура модуля даних ілюстрованого каталогу деталей і складальних одиниць.
Малюнок 3. Структура модуля даних ілюстрованого каталогу деталей і складальних одиниць (XML). Джерело: специфікація S1000D версія 4.0.
На рис. 4 показана XML-розмітка модуля ілюстрованого каталогу деталей і складальних одиниць.
Малюнок 5. Інтерактивний електронний ілюстрований каталог деталей і складальних одиниць, підготовлений в додатку TGBuilder (приклад представлений за допомогою програми TGBrowser)
ілюстрації
Підготовка ілюстрованого каталогу
Підготовкою каталогів на замовлення займаються деякі спеціалізовані організації. Вартість їхніх послуг залежить від кількості модулів в каталозі і від того, чи потрібно підготувати ілюстрації. Підготовка ілюстрацій, особливо тривимірних, може становити суттєву частину витрат.
- Електронний ілюстрований каталог в форматі XML за схемою S1000D.
- Друковану форму ілюстрованого каталогу в форматі PDF.
Для створення каталогу нам будуть потрібні два набору даних:
- Перелік деталей і складальних одиниць, які повинні бути включені в каталог. Для кожної деталі або складальної одиниці перелік повинен містити її позначення, повне найменування, інформацію про розташування в складі вироби в графічному або текстовому вигляді, а також кількість таких деталей або складальних одиниць в розглянутому виробі або підсистемі вироби.
- Набір ілюстрацій із зображеннями деталей і складальних одиниць.
До числа спеціалізованих інструментів для підготовки публікацій за стандартом S1000D відносяться: