2022-11-21 Еще раз о необходимости подготовки человеческих инструкций
По одному из проектов мне понадобилось подготовить инструкцию на санкционные серверы Lenovo SR650. Я вздохнул с облегчением и отложил эту задачу в долгий ящик.
- Во первых это не первый мой проект на серверах леново, еще недавно это был достаточно популярный производитель импортных серверов в России и мне удалось с ними поработать, поэтому кое-какие наработки в этом направлении у меня уже были.
- Во вторых вендор импортный и фигни в инструкции не напишет, подумал я, темболее все руководства доступны на Русском языке на официальном сайте даже после введения санкций.
- В третьих я решил что можно будет частично скопировать качественные мануалы производителя так как выполнены они наверняка на высшем уровне.
- В четвертых я благополучно про эту задачу забыл.
Уровень перевода документов сравним с великим тестом “Гуртовщики мыши”. Для понимания написанного приходится “на лету” переводить обратно в английский.
Документация очень подробная и поэтому практически бесполезная в повседневном использовании, эта книга больше похожа на большую советскую энциклопедию, когда должна быть, по моему мнению журналом “Мурзилка.
Никаких стоящих наработок у меня не оказалось, в виду того что стандарты документации по остальным компонентам подсистемы я задал таким образом что гайды которые были мною написаны несколько лет назад годятся теперь только лишь для одного абзаца.
Идея со страницами-рубрикаторами для руководств администратора сейчас у меня в приоритете и такой формат подачи материала мне кажется более удобным чем “Книга” “все страницы в одной”. Я немного переделал руководство по ”Ядру“ на манер того, как я подготовил ”Росплатформу“. И по их образу и подобию сделал скелет для SR650.
На выходе получается что сводный документ содержащий все разделы нужен лишь только мне для выгрузки подгтовленной документации для дальнейшей ей правки и подготовки к публикации в проект. Обычному пользователю и даже мне наверняка будет удобнее пользоваться рубрикатором. Также в процессе эксплуатации я дополняю руководство дополнительными разделами которые не вошли и не войдут в руководства которые я делаю по проекту, но имеют большую пользу. Данные разделы теперь я тоже включают в рубрикатор и стараюсь найти им заслуженное место.
Такими статьями например стали:
Тем временем я пытаюсь достучаться до офисной лабы с серверами Lenovo чтобы снять скриншоты с XCC, так как в руководстве представлено минимум изображений и минимум смысла по каждой операции.