Цитата:
Сообщение от tiksi
Как писать? Предложение короткое-длинное. Илюстрация в тексте-в приложении. Стиль сухой-с причастиями. Разделов много-мало. Нумерация частая-редкая. Процесс описывать подробно-только упамянуть....
|
По мне так лучший учебник - интерактивный, то есть не всё подряд сверху вниз, а иерархический. Описывается работа какого нибудь узла, в тексте объяснения ссылки подробное описание. Тот кто изучает во первых легко найдёт всё с помощью поиска, во вторых если он хочет изучить какую то тему, то легко перейдёт в нужный раздел в иерархии. и будет читать работу узла, а с помощью ссылок перейдёт на любую справочную информацию по характеристикам аппарата.
Можно задать критерий, допустим время доступа до нужной информации, или количество телодвижений до получения какой либо информации.
Допустим описание включает разделы разных отделений, то тот кто заинтересован в своей части информации вытащит нужное для себя в отдельные страницы. Важно чтобы информация была полной, то есть не было бы ситуации, когда работника интересует количество витков в трансформаторе и он не может это найти или этого нет.
А если писать последовательно в виде книги, то, конечно, для одного она будет слишком подробной, для другого слишком скупой.
А тех людей, которые читают тех. литературу и строят свои монтажные схемы, свои описания работы приборов, которые они не видят в каком то справочнике, то не надо их судить, писатели, то пишут за деньги, а не после того как отстояв смену вымотавшись в ничто. Просто один раз сделав для себя, потом та же работа занимает вместо нескольких часов несколько минут.
Создавать это всё требует времени, поэтому ситуация чем больше людей включатся в работу, тем больше результат. На форумах программистов обсасывают тему до нюансов, предлагают кучу решений, дополняют справку примерами и комментариями, а у нас бывает электровоз есть, а описания нет, как хочешь так и работай.
Цитата:
Сообщение от tiksi
над ним давлеет регламен ГОСТов
|
Ну допустим пишут описание, характеристики чего либо, доходит до того что пишут вес аппарата и марку стали. С одной стороны для завода изготовителя трансформатора и для перевозчиков эта инфа нужна, но она скорее
менее предпочтительна для большего круга читателей. Хотя если справка сделана в виде программы, работающая с базой данных, то можно определить критерии вывода информации, например ввёл "машинист", программа выводит информацию релевантную для машиниста и т.д. Или даже выполнить несколько версий готовых справочников для каждого направления: ремонтникам, машинистам, изготовителю и т.д.
