Неопознанная документация
- Войдите на сайт для отправки комментариев
Народ!
1) Опять страшшшное задание - описать концептуально процессы, для которых предназначена программа. Даже не бизнес-процессы, а скорее физические. И это будет не статья для журнала, а НЕЧТО, что нужно прочесть пользователям до прочтения Руководства 
(
В общем опять "ТО, НЕ ЗНАЮ ЧТО".
Кто-нибудь что-то подобное писал???
2) Алексей, а к Вам лично хочу обратиться...
Я еще совсем "зелень", но когда-нибудь Вам пригожусь... Дайте чуток опыта набраться, я думаю, у меня будет чем поделиться!!!
И будет полностью описывать работу со всей Системой.
Инструкция по эксплуатации КТС разрабатывается для эксплуатационного персонала (грубо говоря - для админов). Для оперативного персонала (юзеров) такая инструкция не предназначена.
В данном же случае мне нужен небольшой документ, который обращает внимание персонала Системы на некоторые моменты их работы. Вместе со службой тех.поддержки были проанализированы ошибки персонала, поломки и отказы техники и т.д. И на основании этого анализа и разрабатывается документ. Его цель: описать некоторые конкретные проблемы и способы их решения.
Тогда надо порыться в ГОСТах на ремонтные документы типа ГОСТ 2.602-95, а также нарыть что-нибудь в ГОСТ 19.508-79 ЕСПД РУКОВОДСТВО ПО ТЕХНИЧЕСКОМУ ОБСЛУЖИВАНИЮ. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ И ОФОРМЛЕНИЮ.
А если по уму, то достаточно сослаться на руководства на УПСы, сетевое оборудования и т.д. Эти руководства Вы так или иначе обязаны передать Заказчику. Так и написал бы - ребята, вот вам руководства от производителя, как RJ-45 выдергивать, учите матчасть.
Уважаемый jaroDS,
что-то Вы перемудрили, если правильно понял Вашу задачу...
Возможно. Поэтому и задаю вопросы.
...Имеются стандарты:
1. ГОСТ 34.201-89 - ВИДЫ, КОМПЛЕКТНОСТЬ И ОБОЗНАЧЕНИЕ ДОКУМЕНТОВ ПРИ СОЗДАНИИ АВТОМАТИЗИРОВАННЫХ СИСТЕМ;
2. РД 50-34.698-90 АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ...
Указанные стандарты есть в наличии, с ними ознакомлен и постоянно использую в работе.
...Наиболее подходящим документом будет "Инструкция по эксплуатации КТС".
Полностью с Вами согласен, но инструкция будет создаваться несколько позже (по не от меня зависящим обстоятельствам). И будет полностью описывать работу со всей Системой.
В данном же случае мне нужен небольшой документ, который обращает внимание персонала Системы на некоторые моменты их работы. Вместе со службой тех.поддержки были проанализированы ошибки персонала, поломки и отказы техники и т.д. И на основании этого анализа и разрабатывается документ. Его цель: описать некоторые конкретные проблемы и способы их решения.
Уважаемый jaroDS,
что-то Вы перемудрили, если правильно понял Вашу задачу.
Имеются стандарты:
1. ГОСТ 34.201-89 - ВИДЫ, КОМПЛЕКТНОСТЬ И ОБОЗНАЧЕНИЕ ДОКУМЕНТОВ ПРИ СОЗДАНИИ АВТОМАТИЗИРОВАННЫХ СИСТЕМ;
2. РД 50-34.698-90 АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ.
Полные тексты указанных документов в сети лежат буквально возле каждого столба.
Во втором документе Вы найдете структуру и содержания документов, перечень и обозначения которых выберете в первом.
Наблюдения за эксплуатирующим и обслуживающим персоналом показал, что очень часто им делаются элементарные ошибки: не соблюдается очередность включения-выключения составляющих, неправильно эксплуатируются ИБП, да что там... вилку RJ-45 ЛВС с ноутбука выдергивают силой вместо того, чтобы аккуратно нажать фиксатор и легонько вытянуть.
Наиболее подходящим документом будет "Инструкция по эксплуатации КТС".
Уважаемые коллеги!
Есть необходимость в создании документа на АСУ. Пока назвал его "Рекомендации по правилам эксплуатации и обслуживания". Но название рабочее, может измениться (благодаря вашим советам).
Теперь конкретнее:
АСУ (программно-технический комплекс) уже создана и введена в эксплуатацию. Уже разработаны руководства пользователя и администратора.
Наблюдения за эксплуатирующим и обслуживающим персоналом показал, что очень часто им делаются элементарные ошибки: не соблюдается очередность включения-выключения составляющих, неправильно эксплуатируются ИБП, да что там... вилку RJ-45 ЛВС с ноутбука выдергивают силой вместо того, чтобы аккуратно нажать фиксатор и легонько вытянуть.
Документ должен иметь рекомендательный характер. Поскольку Система используется в "оборонке" компания, не может что-то требовать, только рекомендовать. А уже на основе наших рекомендаций ими (военными) будет создан соответствующий приказ по войскам.
Пока остановился на следующем содержании:
1. Вступление.
2. Основные положения.
3. Работа с аппаратным обеспечением.
4. Работа с программным обеспечением.
5. Технический осмотр.
6. Ремонтные работы.
7. Охрана труда и техника безопасности.
Возможно, кто-то уже разрабатывал что-нибудь подобное. Буду благодарен за совет.
Какие ГОСТы или другие нормативные документы можно использовать в этом случае?
Жуть, насколько конфиденциально?
Пока не знаю... Прога-то довольно обычная, просто я подписывала договор о конфиденциальности, работаю на этом месте мало - пока еще на испытательном сроке, не совсем понимаю еще что есть что.
Обжегшись на 1С, дуешь на нормальные места...
И еще: по ходу описания процессов станет ясно, чем заполнять разделы "общие сведения" и "назначение".
Эх, показать бы! Да нельзя
Жуть, насколько конфиденциально?
и так по каждому процессу из перечня. Короче, по связке "общие сведения, назначение и состав".
Попробую... Эх, показать бы! Да нельзя
Должно получиться нечто описательного характера
Проблема немного не в этом, но Вы и ГОСТы натолкнули на хорошую мысль - не ломать голову, а, действительно, считать ЭТО описанием программы, где очень большая часть ОБЩИЕ СВЕДЕНИЯ
Правда, эти ОБЩИЕ довольно-таки специальные, но такова прога...
Наверное, лучше так:
- Глоссарий (список терминологии);
- Некие общие сведения о программе в целом;
- Назначение программы;
- Перечень процессов (просто их перечислить);
-- процесс такой-то - общие сведения;
-- процесс такой-то - назначение;
-- процесс такой-то - состав;
...
и так по каждому процессу из перечня. Короче, по связке "общие сведения, назначение и состав".
Главное, что Вы на правильном пути, корнет
А по поводу нечто что-нибудь придумаем, вот только приду в себя от отдыха за рубежом в выходные дни
Корнет из меня еще тот :roll: !!!
Кстати, а Вы опять меня не узнали 
))))) Вот я какая разная!
Насчет "подумаем" спасибочки, пока что я просто сделала:
- Глоссарий
- Назначение
- Процессы
И описываю то, в чем разобралась, оставив временно сомнения насчет того, ЧТО ЖЕ Я ПИШУ???
Вот, что пришло в голову. Можно слить разделы ГОСТ 19.402-78 и ГОСТ 19.502-78
Должно получиться нечто описательного характера, вроде того, что программа заглатывает входные данные, чуток думает, а затем выходные данные выдает. А это и есть описание процесса деятельности.
Можно взять еще и РД 50-34.698-90 и просмотреть документы, название которых начинается со слова "Описание". И надергать подходящих разделов оттуда.
2) Алексей, а к Вам лично хочу обратиться...
Я еще совсем "зелень", но когда-нибудь Вам пригожусь... Дайте чуток опыта набраться, я думаю, у меня будет чем поделиться!!!
Главное, что Вы на правильном пути, корнет
А по поводу нечто что-нибудь придумаем, вот только приду в себя от отдыха за рубежом в выходные дни 
- Войдите на сайт для отправки комментариев
Уважаемый surgeon,
Аграмадное Вам "СПАСИБО".
А если по уму, то достаточно сослаться на руководства на УПСы, сетевое оборудования и т.д. Эти руководства Вы так или иначе обязаны передать Заказчику. Так и написал бы - ребята, вот вам руководства от производителя, как RJ-45 выдергивать, учите матчасть.
Сейчас так и сделаю и потороплю руководство по вопросу создания инструкции.