Приложение А (справочное). Оформление руководства по эксплуатации

Приложение А
(справочное)

Оформление руководства по эксплуатации

А.1 Общие положения

В настоящем приложении приведены рекомендации по представлению и оформлению руководств по эксплуатации землеройных машин.

А.1.1 Формат бумаги

Предпочтительный формат бумаги - А4 (210 мм х 297 мм). При необходимости может быть использован другой формат, например А5 (210 мм х 148 мм).

А.1.2 Обложки

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

А.1.3 Заметки

В конце руководства по эксплуатации может быть оставлена одна или две пустые страницы для заметок о конкретных условиях эксплуатации машины.

А.2 Оформление текста руководства по эксплуатации

А.2.1 Общие сведения

Руководство по эксплуатации должно быть написано в таком стиле и таким языком, чтобы оператор мог легко понять его содержание. Руководство по эксплуатации должно составляться на языках стран, в которые будет поставляться машина.

А.2.2 Стиль текста

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

Указания должны даваться в утвердительной и повелительной форме. Использование отрицательных высказываний нужно свести к минимуму.

А.3 Издательское оформление

А.3.1 Размер шрифта

Размер шрифта основного текста должен быть не менее 10 пунктов.

А.3.2 Колонки

На бумаге формата А4 текст, как правило, должен быть напечатан в две колонки, а на бумаге формата А5 - в одну колонку.

А.3.3 Заголовки

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

А.4 Условные обозначения в тексте

А.4.1 Общие сведения

Во всем тексте руководства по эксплуатации орфография, нумерация, символы и т.п. должны применяться единообразно.

А.4.2 Терминология и размеры

Чертежи с размерами в соответствии с ISO 6746-1 и ISO 6746-2 и терминология в соответствии со стандартами, устанавливающими терминологию и торговые характеристики, должны использоваться единообразно во всем тексте руководства по эксплуатации.

А.4.3 Символы

Графические символы для органов управления и устройств отображения информации должны соответствовать ISO 6405-1 и ISO 6405-2. Все термины и символы должны быть определены.

А.4.4 Прописные буквы

Использование слов, напечатанных прописными буквами, нужно свести к минимуму. Как правило, для того, чтобы привлечь внимание к ключевым словам и фразам, лучше использовать строчные буквы в сочетании с жирным шрифтом. Прописные буквы можно использовать при упоминании органов управления, на которых имеются идентифицирующие надписи (например, надпись "СТОП").

А.4.5 Единицы измерения и величины

Все Единицы измерения и величины должны быть выражены в единицах Международной системы единиц (СИ). При необходимости в круглых скобках могут быть даны эквивалентные значения в других единицах.

А.4.6 Числовые значения

Все числовые значения должны быть записаны арабскими цифрами. Если предложение начинается с числа, число должно быть записано словами, или предложение должно быть переформулировано так, чтобы оно не начиналось с числа. Цифры в числах, состоящих более чем из четырех цифр (за исключением дат), должны быть сгруппированы по три, например, 21 000.

А.5 Иллюстрации

А.5.1 Общие сведения

Иллюстрации, сопровождающиеся текстом, являются, как правило, "удобным для пользова