Предложите, как улучшить StudyLib
(Для жалоб на нарушения авторских прав, используйте
другую форму
)
Ваш е-мэйл
Заполните, если хотите получить ответ
Оцените наш проект
1
2
3
4
5
В данном пункте Приложения к ЭЗ представляется вся документация педагога по программно-методическому сопровождению образовательного процесса, под которым подразумевается целый комплекс учебно-методических материалов, включающий:
- рабочую программу по предмету,
- методические разработки,
- дидактический материал.
Рабочая программа – это индивидуальный инструмент педагога, в котором он определяет наиболее оптимальные и эффективные для определенного класса содержание, формы, методы и приемы организации образовательного процесса с целью получения результата, соответствующего требованиям ФГОС. Следует отметить, что реализацию преподаваемых учебных предметов, курса, дисциплины (модуля) педагог обязан обеспечивать в полном объеме в соответствии с утвержденной рабочей программой (ст. 48, ч.1, п.1 Федерального закона “Об образовании в Российской Федерации”).
При разработке рабочей программы по предмету рекомендуется придерживаться следующих требований:
- она должна соответствовать основной образовательной программе образовательной организации;
- обеспечивать достижение планируемых результатов освоения основной образовательной программы (начального общего, основного общего и среднего (полного) общего образования) образовательной организации;
- структура и содержание программы должны соответствовать логике изложения учебного материала учебника, выбранного из федерального перечня учебников, рекомендуемых к использованию при реализации имеющих государственную аккредитацию образовательных программ начального общего, основного общего, среднего общего образования (статья 18, пункта 4 ФЗ «Об образовании в РФ»).
Методическая разработка – это издание, содержащее конкретные материалы в помощь проведению какого-либо мероприятия, сочетающее методические советы и рекомендации (Полонский В. М. Словарь понятий и терминов по законодательству Российской Федерации об образовании).
К основным видам методических разработок можно отнести конспект урока/занятия, сценарий мероприятия, разработку авторской методики/технологии преподавания предмета и т.п.
При подготовке методических разработок педагогу желательно придерживаться следующих рекомендаций:
а) методическая разработка должна состоять из двух частей: пояснительной записки и основной части;
б) в пояснительной записке обосновываются актуальность методической разработки и причины, по которым педагог предлагает действовать тем или иным способом, использовать те или иные материалы. Здесь же аргументируется новый подход, позволяющий решить возникшую проблему или противоречие, показываются преимущества и результативность разработанного. Пояснительная записка может быть, как краткой, так и развернутой. Но главное – автор должен ответить на вопросы: почему сделана работа? Таким образом, в пояснительной записке обосновывается целесообразность данной методической разработки;
в) основная часть методической разработки должна содержать материал, представляемый педагогом. В ней автор излагает содержание своей разработки, отвечая на вопросы: что предлагается? Зачем? Как необходимо действовать? Методическая разработка может быть индивидуальной и коллективной (в этом случае необходимо указать долю авторского участия). Она должна быть рассмотрена профессиональным сообществом (методическое объединение уровня ОУ/ГМО/РМО либо профильной кафедрой вуза). Это подтверждается выпиской из протокола заседания, копиями отзывов, рецензиями.
Дидактический материал — особый вид пособий для учебных занятий, использование которых способствует активизации познавательной деятельности обучаемых, экономии учебного времени(Словарь-справочник / под ред. Моисеева В.Б. — Пенза, 2002).
Дидактический материал – это особый тип наглядных учебных пособий, раздаваемых учащимся для самостоятельной работы на уроке или дома, или демонстрируемых педагогом перед всем классом (Профессиональное образование. Словарь. Ключевые понятия, термины, актуальная лексика. — М.: НМЦ СПО. С.М. Вишнякова. 1999).
Использованиедидактического материала позволяет педагогу максимально полно раскрывать отдельные разделы и темы образовательной программы, что в конечном итоге способствует более быстрому и осознанному усвоению материала обучающимися.
Дидактические материалы должны быть подчинены целям и задачам учебного процесса и могут быть представлены как на бумажных, так и на электронных носителях. Среди множества видов дидактических материалов, можно выделить следующие:
- демонстрационный материал (иллюстрации, рисунки (в том числе детей), модели, макеты, видеонарезки, видеоролики, карты, схемы, графики, диаграммы и т.п.));
- раздаточный материал (задания для выполнения конкретных учебных задач, наборы карточек, незаполненные таблицы, незавершенные схемы для выполнения заданий дифференцированного или индивидуализированного характера, материал для выполнения лабораторных и практических работ и т.п.).
Оформляя дидактический материал в портфолио, педагогу рекомендуется также уделить внимание их грамотности и эстетическому виду. Кроме того, немаловажным фактором является нацеленность дидактических материалов на развитие творческих способностей обучающихся.
При проведении процедуры экспертизы оценка деятельности педагога по данному показателю осуществляется в зависимости от количества представленных им методических разработок и дидактических материалов (при условии их грамотного оформления в соответствии с обозначенными выше требованиями). При этом начисление баллов определяется степенью охвата программно-методическим сопровождением всего преподаваемого курса. Формулировка «Разрабатывает периодически», в экспертном заключении, предполагает наличие методических и дидактических материалов по одной или нескольким темам курса в соответствии с реализуемой рабочей программой. В экспертном заключении данный показатель оценивается дифференцированно (от 10 до 100 баллов). Так, к примеру, если педагогический работник представил методический и дидактический материал только под одной теме, то он может получить 10 баллов. При наличии методического сопровождения по более, чем 25% темам учебного курса, педагогу может быть начислено 50 баллов. 100 баллов аттестуемый получит в том случае, если представит методические разработки и дидактический материал к половине тем курса. Формулировка «Разрабатывает систематически» подразумевает предоставление вышеуказанных материалов практически по всем темам курса. Диапазон дифференцированной оценки составляет от 110 до 200 баллов. Технология начисления баллов аналогична периодической разработке. При этом следует учитывать, что разработанные педагогом материалы должны быть систематизированы в строгом соответствии с последовательностью изложения тем в рабочей программе.
информация взята с сайта http://ruzumc.eduruza.ru/
ДОКУМЕНТАЛЬНОЕ СОПРОВОЖДЕНИЕ МОНИТОРИНГОВОЙ ДЕЯТЕЛЬНОСТИ
КЛАССНОГО РУКОВОДИТЕЛЯ В ОБРАЗОВАТЕЛЬНОМ УЧРЕЖДЕНИИ
Аширова
М.А.
Муниципальное
казенное общеобразовательное учреждение
«Средняя
общеобразовательная школа № 7»
С.
Пелагиада Шпаковского района Ставропольского края
Специфика
воспитательной системы определяется идеологией развития содержания образования
в школе, социальным заказом социума, родителей и самого ребенка. Воспитание в
школе призвано обеспечивать условия образовательного процесса, в результате
которого учащийся определяет способ своей жизнедеятельности, становится
устроителем своей судьбы. Воспитательная работа строится по следующим
направлениям:
·
Духовно —
нравственное,
·
Гражданско —
патриотическое,
·
Экологическое,
·
Аналитико —
диагностическое,
·
Спортивно —
физическое.
Современная трактовка
профессиональной компетентности классного руководителя понимается как —
совокупная характеристика личности педагога, который на основе педагогической,
методической и исследовательской деятельности, овладевает знаниями,
умениями и навыками эффективного решения актуальных воспитательных задач.
Классный
руководитель в ходе своей работы создает условия для саморазвития и
самореализации личности обучающегося, его успешной социализации в обществе.
Деятельность классного руководителя представляет собой использование ресурсов
общеобразовательного учреждения и социума для реализации задач воспитания
учащихся вверенного ему класса.
В современной школе
деятельность классного руководителя сопровождается множеством различных
документов, регламентирующих различные стороны его деятельности.
Ответственность классного руководителя охватывает различные стороны
жизнедеятельности воспитанников и может быть выражена в инвариантном и
вариативном компонентах.
Инвариантный
компонент деятельности классного руководителя включает в себя:
· обеспечение жизни и
здоровья учащихся (контроль посещаемости школы обучающимися
класса и причин пропусков учебных занятий; информированность о состоянии
здоровья учащихся класса; работа с листком здоровья в классном журнале;
совместно с медицинским работником и родителями разработка и реализация
комплекса мер по охране и укреплению здоровья; вовлечение учащихся в занятия
физкультурной и спортивной деятельностью; организация горячего питания;
проведение инструктажей и ведение документации по технике безопасности);
· обеспечение позитивных
межличностных отношений в классном коллективе и между обучающимися и учителями (информированность
о межличностных взаимоотношениях в классе; о характере взаимоотношений между
обучающимися класса и ведущими занятия в классе учителями, проведение
диагностики межличностных отношений; оперативное регулирование возникающих
противоречий; определение задач оптимизации психологического климата в классе;
выявление учащихся имеющих проблемы в сфере межличностных отношений;
привлечение для этой работы психолого-педагогической службы);
· содействие освоению
школьниками образовательных программ (информированность об особенностях
содержания образования, предусмотренного учебным планом, о проблемах и
перспективах реализации образовательной программы в ученическом классе;
координация деятельности учителей-предметников и родителей; прогнозирование и
мониторинг успеваемости; содействие в разработке и реализации индивидуальных
траекторий образования; планирование и реализация работы с одаренными и с
неуспевающими учащимися);
· воспитание патриотических
чувств, формирование опыта гражданско-правового поведения, развитие социальной
компетентности учащихся (разработка годового цикла мероприятий,
содействующих воспитанию патриотизма и гражданственности, расширяющих правовую
и социальную компетенцию обучающихся; содействие в формировании опыта
гражданского поведения в процессе ученического самоуправления, равнение на
эталоны гражданственности; планомерное развитие ученического самоуправления на
основе договоров при взаимодействии классного руководителя и учащихся).
Вариативный
компонент деятельности классного руководителя тесно привязан к личности
педагога, осуществляющего классное руководство, его мотивации, профессиональной
компетентности предполагает:
· специфическую
воспитательную работу (комплексное изучение состояния, проблем и
определение перспектив в воспитании, обучении, развитии учащихся класса;
качественное и обоснованное целеполагание и планирование работы с классом;
ведение отчетной документации; осуществление мониторинга эффективности собственной
деятельности; организация участия детей в конкурсах соревнованиях школьного,
районного, краевого и Всероссийского уровня);
· профилактическую работу (выявление
обучающихся — потенциальных нарушителей дисциплины; разработка, согласование с
социальным педагогом, психологом, администрацией школы, родительским комитетом
и реализация комплекса профилактических мер с привлечением широкого круга
участников и использование возможностей различных организаций социума).
Структура
мониторинга воспитания в широком значении состоит из четырех элементов:
1.
изучения
состояния воспитания путем непосредственного наблюдения за ним;
2.
оценки
состояния воспитания;
3.
прогноза
развития воспитания;
4.
выработки
предложений мер по развитию позитивных и предупреждению выявленных негативных
процессов.
В соответствии с
приказом Минобразования РФ от 27.12.2002, воспитательная деятельность
образовательного учреждения оценивается по двум критериям:
·
наличие в
образовательном учреждении условий для внеучебной работы с обучающимися;
·
организация
воспитательной работы с обучающимися и формирование стимулов развития личности.
Для конкретизации
анализа деятельности по достижению цели работы
школы мониторинг подразделяется на две группы.
В первую группу
входят объективные статистические показатели:
·
Процент
успеваемости и посещаемости.
·
Количество
правонарушений, совершенных учащимися.
·
Количество
учащихся класса состоящих на внутришкольном учете, на учете в ОДН, КДН.
·
Участие
(результаты) учащихся в школьных, районных, городских и российских конкурсах и
проектах.
·
Процент охвата
учащихся горячим питанием.
·
Количество
конфликтных ситуаций (с родителями, среди учащихся, с учителями).
Во вторую группу
входят показатели анализа эффективности процесса воспитания:
· диагностика
уровня развития классного коллектива (Социометрия);
Социометрия
применяется для диагностики межличностных и межгрупповых отношений в целях их
изменения, улучшения и
совершенствования. Социометрическая
методика используется классными руководителями в каждом отдельном
классе и этот метод, занимает одно из мест в ряду аналитических
методов, таких как анкетирование, интервью, наблюдение.
Социометрический метод ни в коем случае их не заменяет, а наоборот гармонично
дополняет. Для изучения малых групп, их структур, внутригрупповых связей,
выявления конфликтов в группах и между группами, количественных оценок
сплоченности, статуса, неформального лидерства он является оптимальным. Кроме
содержательного соответствия метода изучаемой области, он обладает рядом
преимуществ по сравнению с другими методами анализа. Во — первых, метод
довольно прост в технической реализации. Не требуется проведения предтестовых
процедур, проверки валидности методики. Подготовка форм (опросных листов) не
вызывает затруднений, даже у неподготовленного человека. Во — вторых,
длительность проведения исследовательской процедуры не велика. Опросные листы
могут заполняться заочно, а обработка данных занимает всего несколько часов. В-
третьих, социометрия позволяет оперировать количественными данными.
Качественное описание сплоченности группы менее информативно, а применение
социометрии дает довольно точную количественную оценку, например, при
целенаправленном командообразовании.
Социометрическая процедура может иметь
целью:
а) измерение степени сплоченности-разобщенности в
группе;
б) выявление «социометрических позиций», т. е. соотносительного авторитета
членов группы по признакам симпатии-антипатии, где на крайних
полюсах оказываются «лидер» группы и «отвергнутый»;
в) обнаружение внутригрупповых подсистем, сплоченных образований, во главе
которых могут быть свои неформальные лидеры.
· уровень
воспитания ученика, класса и школы в целом (Уровень воспитанности);
Проблема
диагностики воспитанности учащихся всегда была одной из самых актуальных в
педагогике. В последнее время она приобрела еще большую остроту в связи с
разработкой и принятием критериев качества образования. Что понимать под
«воспитанностью»? По каким критериям судить о «воспитанности»? Под
воспитанностью традиционно понимают совокупность знаний о нормах поведения в
обществе и умение применять эти знания во взаимоотношениях с окружающими
людьми. Поскольку все, что касается поведения человека в социуме, его отношений
к людям, характеризует нравственный мир личности, то, когда говорят о
воспитанности, подразумевают именно нравственную воспитанность.
Выявлять, тем
более измерять воспитательные результаты чрезвычайно
сложно. Об этом знают все педагоги — практики, поскольку
формирующаяся личность школьника находиться в постоянном
развитии.
В тоже время
классному руководителю нужно помнить, что диагностика важна не сама по себе, а
с целью коррекции воспитательной деятельности, и предупреждения отклонений в
поведении детей.
Определить
уровень воспитанности школьника можно только после полностью
проведенного исследования, когда есть возможность сравнить ответы, суждения,
устные и письменные высказывания школьника, его поведения и реакции в
различных жизненных ситуациях. Умный и чуткий
педагог любое дело в классе, любую индивидуальную
беседу использует как своеобразный тест для изучения уровня
воспитанности в зависимости каким содержанием заполнены эти дела.
Для
диагностики уровня воспитанности школьников классными руководителями школы и
мной используются следующие различные известные методики
и методы:
1.
«Незаконченный тезис» (Н.Е. Щуркова).
2.
Анкеты о нравственных идеалах и эстетических интересах. Например
«Нравственные
нотки поведения»,
3.
Сочинение «Мой идеал».
4.
Педагогические характеристики.
5.
Педагогическое наблюдение, ситуация выбора, анализ конфликта, ролевые игры.
6.
Индивидуальная беседа.
Степень воспитанности
делится обычно на 5 уровней:
1 уровень — не знает норм
и правил поведения.
2 уровень — знает, но не
ведет себя в соответствии с ними.
3 уровень — нормы, правила
поведения имеют личностный смысл, но поведение
ситуативно, не постоянно.
4 уровень — знание норм,
правил, обязанностей стало внутренней потребностью
личности.
5 уровень — знание норм,
правил, обязанностей стало внутренней потребностью
личности. Постоянное нравственное поведение.
Примерные показатели
уровня воспитанности учащихся:
1 Учебная
и социальная активность
2 Морально-волевые
качества
3 Коммуникативные
качества
4 Здоровье. Здоровый
образ жизни.
· эмоционального
настроя класса.
Это тот
благоприятный либо стрессогенный фон, на котором разворачивается
основная деятельность ребенка в школе.
Для
изучения атмосферы в классе классными руководителями применяются
метод наблюдения, бесед, тесты «Психологический климат в
классе», «Самоконтроль и общение», «Умеете ли вы общаться» и.т.д,
· а
также диагностики, входящие в мониторинг программ, работающих в
школе («Путь к успеху», «Предпрофильная подготовка и
профориентация», «Здоровье», компьютеризации).
Каждый ученический класс по-своему
уникален, деятельность классного руководителя происходит в различные периоды
социально-психологического развития коллектива. Отсюда сравнивать успехи
классных руководителей, работающих, например, в обычном классе и классе
социально неблагополучном достаточно проблематично, т. к. цели и темпы
реализации воспитательных задач будут существенно отличаться. Объектом
сравнения могут быть только адекватность целей воспитательной работы ситуации,
сложившейся в классе, соответствие планов поставленным целям и т. п.
Мониторинг эффективности работы классного руководителя может стать
деятельностью, объединяющей администрацию школы, родительскую общественность,
представителей различных служб (медицинского работника, психолога, социального
педагога и т. п.).
Практическая работа №13
Тема: Руководство пользователя.
Цель работы: Ознакомиться с видами руководства
пользователя, изучить нормативно правовую документацию, регламентирующую
разработку руководств пользователя, приобрести навыки разработки руководства
пользователя программного средства.
Теоретические
сведения.
Руководство
пользователя (user guide или user
manual), руководство по эксплуатации, руководство
оператора — документ, назначение которого — предоставить людям помощь
в использовании некоторой системы. Документ входит в состав технической
документации на систему и, как правило,
подготавливается техническим писателем.
Большинство
руководств пользователя помимо текстовых описаний содержит изображения. В
случае программного обеспечения, в
руководство обычно включаются снимки экрана, при
описании аппаратуры — простые и понятные рисунки или фотографии. Используется
стиль и язык, доступный предполагаемой аудитории, использование жаргона сокращается до
минимума либо подробно объясняется.
Содержание
Типичное
руководство пользователя содержит:
·
Аннотацию, в
которой приводится краткое изложение содержимого документа и его назначение
·
Введение,
содержащее
ссылки на связанные документы и информацию о том, как лучше всего использовать
данное руководство
·
Страницу
содержания
·
Главы,
описывающие, как использовать, по крайней мере, наиболее важные функции
системы
·
Главу, описывающую
возможные проблемы и пути их решения
·
Часто
задаваемые вопросы и ответы
на них
·
Где
ещё найти информацию по предмету, контактная информация
·
Глоссарий и, в
больших документах, предметный указатель
Все главы и
пункты, а также рисунки и таблицы, как правило, нумеруются, с тем, чтобы на них
можно было сослаться внутри документа или из другого документа. Нумерация также
облегчает ссылки на части руководства, например, при общении пользователя со
службой поддержки.
Стандарты
Структура и
содержание документа Руководство пользователя автоматизированной
системы регламентированы подразделом 3.4 документа РД 50-34.698-90. Структура и
содержание документов Руководство оператора, Руководство
программиста, Руководство системного программиста регламентированы
ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.
·
Комплекс
стандартов и руководящих документов на автоматизированные системы (ГОСТ 34)
· РД
50-34.698-90 АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ
·
Единая система конструкторской документации (ЕСКД)
определяет документ «Руководство по эксплуатации» и другие документы:
· ГОСТ
2.601-2013 Эксплуатационные документы
· ГОСТ
2.610-2006 Правила выполнения эксплуатационных документов
·
Единая
система программной документации (ЕСПД)
определяет документы «Руководство оператора», «Руководство по техническому обслуживанию»
и их структуру:
· ГОСТ
19.101-77 Виды программ и программных документов
· ГОСТ
19.105-78 Общие требования к программным документам
· ГОСТ
19.505-79 Руководство оператора. Требования к содержанию и оформлению
· ГОСТ
19.508-79 Руководство по техническому обслуживанию. Требования к содержанию и
оформлению.
Руководство
пользователя согласно требованиям ГОСТ
Документ
«Руководство пользователя» относится к пакету эксплуатационной документации.
Основная цель руководства пользователя заключается в обеспечении пользователя
необходимой информацией для самостоятельной работы с программой или
автоматизированной системой.
Таким
образом, документ Руководство пользователя должен отвечать на следующие
вопросы: что это за программа, что она может, что необходимо для обеспечения ее
корректного функционирования и что делать в случае отказа системы.
Руководящими
стандартами для создания документа Руководство пользователя могут
являться как РД
50-34.698-90 в п.п. 3.4. «Руководство пользователя», так
и ГОСТ
19.505-79 «Руководство оператора. Требования к содержанию и оформлению». Ниже для
сравнения приведены структуры документа согласно двум перечисленным стандартам.
РД |
ГОСТ 19.505-79 Руководство оператора |
Введение |
|
Область |
|
Описание |
|
Уровень |
|
Перечень |
|
Назначение |
|
Виды |
Назначение |
Условия, |
Условия |
Подготовка |
Выполнение |
Состав |
|
Порядок |
Порядок |
Проверка |
|
Описание |
Описание |
Описание |
|
Описание |
|
Аварийные |
Сообщения |
Рекомендации |
Таким образом, мы можем выделить следующие основные разделы руководства
пользователя:
ü Назначение
системы;
ü Условия применения
системы;
ü Подготовка системы
к работе;
ü Описание операций;
ü Аварийные
ситуации.
Назначение системы
Данный раздел
документа Руководство пользователя должен содержать информацию о назначении
системы, ее целях и задачах.
Пример:
«Корпоративный
интранет портал предназначен для повышения корпоративной культурыр организации
эффективного взаимодействия сотрудников.
Основной
целью Порта является создание единого информационного пространства предприятия
и оптимизация работы сотрудников путем облегчения коммуникаций между ними и
оптимизации ряда бизнес-процессов.»
Условия
применения системы
Данный
раздел документа Руководство пользователя должен включать все те факторы,
которые необходимы для корректной работы системы. Здесь можно выделить
несколько подразделов:
Требования
к аппаратному обеспечению – сюда можно включить требования к конфигурации
компьютера пользователя, программное обеспечение необходимое для работы
Системы, а также наличие дополнительного оборудования (принтер, сканер и т.п.),
если таковое необходимо;
Квалификация
пользователя – данный подраздел должен содержать требования к навыкам и знаниям
пользователя (пример: «Пользователи должны обладать навыками работы с
операционной системой Windows XP»);
Подготовка
системы к работе
Данный
раздел документа Руководство пользователя должен содержать пошаговую инструкцию
для запуска приложения. К этапу подготовки системы к работе можно отнести
установку дополнительных приложений (при необходимости), идентификацию,
аутентификацию и т.п.
Описание
операций
Это
основной раздел документа Руководство пользователя, который содержит пошаговую
инструкцию для выполнения того или иного действия пользователем.
Если
работа автоматизированной системы затрагивает целый бизнес-процесс, то в
руководстве пользователя перед описанием операций целесообразно предоставить
информацию о данном процессе его назначении и участниках. Подобное решение
позволяет человеку четко представить свою роль в данном процессе и те функции,
которые реализованы для него в системе.
Далее в
документе Руководство пользователя следует представить описание функций
разбитых на отдельные операции. Необходимо выделить подразделы, описывающие
функции данного процесса, и действия, которые необходимо совершить для их
выполнения.
Пример:
«4.1
Согласование проекта. Данный процесс предназначен для организации работы
сотрудников, участвующих в разработке и согласовании проекта.
Автор проекта создает запись в Системе и прикрепляет пакет необходимой
документации, далее проект передается на согласование руководящими лицами.
Руководители после ознакомления с проектом могут подтвердить его или отправить
на доработку Автору.
4.1.1
Создание проекта. Для того чтобы создать Проект необходимо на панели «…»
нажать на кнопку «…» и в появившейся форме заполнить следующие поля:
Наименование
проекта;
Описание
проекта;
Следующие
поля заполняются автоматически:
Дата
создания проекта – текущая дата;
Автор –
ИФО и должность автора проекта.»
Руководство
пользователя может представлять собой как краткий справочник по основному
функционалу программы, так и полное учебное пособие. Методика изложения
материала в данном случае будет зависеть от объема самой программы и требований
заказчика.
Чем
подробнее будут описаны действия с системой, тем меньше вопросов возникнет у
пользователя. Для более легкого понимания всех принципов работы с программой
стандартами в документе Руководство пользователя допускается использовать
схемы, таблицы, иллюстрации с изображением экранных форм.
Для
крупных автоматизированных систем рекомендуется создавать отдельное руководство
для каждой категории пользователя (пользователь, модератор и т.п.). Если в
работе с системой выделяются дополнительные роли пользователей, то в документе
Руководство пользователя целесообразно поместить таблицу распределения функций
между ролями.
Аварийные
ситуации
Данный
раздел документа Руководство пользователя должен содержать пошаговые инструкции
действий пользователя в случае отказа работы Системы. Если к пользователю не
были предъявлены особые требования по администрированию операционной системы и
т.п., то можно ограничиться фразой «При отказе или сбое в работе Системы
необходимо обратиться к Системному администратору».
Ниже представлен пример (образец)
документа «Руководство пользователя«, разработанного на
основании методических указаний РД
50-34.698-90.
Данный документ формируется
IT-специалистом, или функциональным специалистом, или техническим писателем в
ходе разработки рабочей документации на систему и её части на стадии «Рабочая
документация».
Для формирования руководства пользователя
в качестве примера был взят инструмент Oracle Discoverer информационно-аналитической
системы «Корпоративное хранилище данных».
Ниже приведен состав руководства
пользователя в соответствии с ГОСТ. Внутри каждого из разделов кратко приведены требования к
содержанию и текст примера заполнения (выделен вертикальной
чертой).
Разделы руководства пользователя:
1.
Введение.
2.
Назначение и
условия применения.
3.
Подготовка к
работе.
4.
Описание операций.
5.
Аварийные
ситуации.
6.
Рекомендации по
освоению.
1. Введение
В разделе «Введение»
указывают:
1.
область применения;
2.
краткое
описание возможностей;
3.
уровень
подготовки пользователя;
4.
перечень
эксплуатационной документации, с которой необходимо ознакомиться пользователю.
1.1. Область применения
Требования настоящего документа
применяются при:
· предварительных комплексных
испытаниях;
· опытной эксплуатации;
· приемочных испытаниях;
· промышленной эксплуатации.
1.2. Краткое описание возможностей
Информационно-аналитическая
система Корпоративное Хранилище Данных (ИАС КХД) предназначена для оптимизации
технологии принятия тактических и стратегических управленческих решений
конечными бизнес-пользователями на основе информации о всех аспектах
финансово-хозяйственной деятельности Компании.
ИАС КХД предоставляет возможность
работы с регламентированной и нерегламентированной отчетностью.
При работе с отчетностью
используется инструмент пользователя Oracle Discoverer Plus, который
предоставляет следующие возможности:
· формирование табличных и
кросс-табличных отчетов;
· построение различных диаграмм;
· экспорт и импорт результатов
анализа;
· печать результатов анализа;
· распространение результатов
анализа.
1.3. Уровень подготовки
пользователя
Пользователь ИАС КХД должен иметь
опыт работы с ОС MS Windows (95/98/NT/2000/XP), навык работы с ПО Internet
Explorer, Oracle Discoverer, а также обладать следующими знаниями:
· знать соответствующую предметную
область;
· знать основы многомерного анализа;
· понимать многомерную модель
соответствующей предметной области;
· знать и иметь навыки работы с
аналитическими приложениями.
Квалификация пользователя должна
позволять:
· формировать отчеты в Oracle
Discoverer Plus;
· осуществлять анализ данных.
1.4. Перечень эксплуатационной
документации, с которой необходимо ознакомиться пользователю
· Информационно-аналитическая
система «Корпоративное хранилище данных». ПАСПОРТ;
· Информационно-аналитическая
система «Корпоративное хранилище данных». ОБЩЕЕ ОПИСАНИЕ СИСТЕМЫ.
2. Назначение и условия применения
Oracle Discoverer Plus
В разделе «Назначение и
условия применения» указывают:
1.
виды
деятельности, функции, для автоматизации которых предназначено данное средство
автоматизации;
2.
условия, при
соблюдении (выполнении, наступлении) которых обеспечивается применение средства
автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация
технических средств, операционная среда и общесистемные программные средства,
входная информация, носители данных, база данных, требования к подготовке
специалистов и т. п.).
Oracle Discoverer Plus в составе
ИАС КХД предназначен для автоматизации подготовки, настройки отчетных форм по
показателям деятельности, а также для углубленного исследования данных на
основе корпоративной информации хранилища данных.
Работа с Oracle Discoverer Plus в
составе ИАС КХД возможна всегда, когда есть необходимость в получении
информации для анализа, контроля, мониторинга и принятия решений на ее основе.
Работа с Oracle Discoverer Plus в
составе ИАС КХД доступна всем пользователям с установленными правами доступа.
3. Подготовка к работе
В разделе «Подготовка к работе»
указывают:
1.
состав и
содержание дистрибутивного носителя данных;
2.
порядок
загрузки данных и программ;
3.
порядок
проверки работоспособности.
3.1. Состав и содержание
дистрибутивного носителя данных
Для работы с ИАС КХД необходимо
следующее программное обеспечение:
1.
Internet
Explorer (входит в состав операционной системы Windows);
2.
Oracle
JInitiator устанавливается автоматически при первом обращении пользователя к
ИАС КХД.
3.2. Порядок загрузки данных и
программ
Перед началом работы с ИАС КХД на
рабочем месте пользователя необходимо выполнить следующие действия:
1.
Необходимо
зайти на сайт ИАС КХД ias-dwh.ru.
2.
Во время
загрузки в появившемся окне «Предупреждение о безопасности», которое
будет содержать следующее: ‘Хотите установить и выполнить «Oracle JInitiator»
…’ Нажимаем на кнопку «Да».
3.
После чего
запуститься установка Oracle JInitiator на Ваш компьютер. Выбираем кнопку Next
и затем OK.
3.3. Порядок проверки
работоспособности
Для проверки доступности ИАС КХД с
рабочего места пользователя необходимо выполнить следующие действия:
1.
Открыть
Internet Explorer, для этого необходимо кликнуть по ярлыку «Internet Explorer»
на рабочем столе или вызвать из меню «Пуск».
2.
Ввести в
адресную строку Internet Explorer адрес: ias-dwh.ru и нажать «Переход».
3.
В форме аутентификации
ввести пользовательский логин и пароль. Нажать кнопку «Далее».
4.
Убедиться, что
в окне открылось приложение Oracle Discoverer Plus.
В случае если приложение Oracle
Discoverer Plus не запускается, то следует обратиться в службу поддержки.
4. Описание операций
В разделе «Описание
операций» указывают:
1.
описание всех
выполняемых функций, задач, комплексов задач, процедур;
2.
описание
операций технологического процесса обработки данных, необходимых для выполнения
функций, комплексов задач (задач), процедур.
Для каждой операции обработки
данных указывают:
1.
наименование;
2.
условия, при
соблюдении которых возможно выполнение операции;
3.
подготовительные
действия;
4.
основные
действия в требуемой последовательности;
5.
заключительные
действия;
6.
ресурсы, расходуемые
на операцию.
В описании действий допускаются
ссылки на файлы подсказок, размещенные на магнитных носителях.
4.1. Выполняемые функции и задачи
Oracle Discoverer Plus в составе
ИАС КХД выполняет функции и задачи, приведенные в таблице ниже:
Функции |
Задачи |
Описание |
Обеспечивает многомерный |
Визуализация отчетности |
В ходе выполнения данной |
Формирование табличных и |
В ходе выполнения данной |
4.2. Описание операций
технологического процесса обработки данных, необходимых для выполнения задач
Ниже приведено описание
пользовательских операций для выполнения каждой из задач.
Задача:
«Визуализация отчетности»
Операция 1: Регистрация на портале
ИАС КХД
Условия,
при соблюдении которых возможно выполнение операции:
1.
Компьютер
пользователя подключен к корпоративной сети.
2.
Портал ИАС КХД
доступен.
3.
ИАС КХД
функционирует в штатном режиме.
Подготовительные
действия:
На компьютере пользователя
необходимо выполнить дополнительные настройки, приведенные в п. 3.2 настоящего
документа.
Основные
действия в требуемой последовательности:
1.
На иконке «ИАС
КХД» рабочего стола произвести двойной щелчок левой кнопкой мышки.
2.
В открывшемся
окне в поле «Логин» ввести имя пользователя, в поле «Пароль» ввести пароль пользователя.
Нажать кнопку «Далее».
Заключительные
действия:
Не требуются.
Ресурсы,
расходуемые на операцию:
15-30 секунд.
Операция 2: Выбор отчета
Условия,
при соблюдении которых возможно выполнение операции:
Успешная регистрация на Портале
ИАС КХД.
Подготовительные
действия:
Не требуются.
Основные
действия в требуемой последовательности:
1. В появившемся окне «Мастер
создания рабочих книг» поставить точку напротив пункта «Открыть существующую
рабочую книгу».
2. Выбрать нужную рабочую книгу и
нажать кнопку «Откр.»:
Заключительные действия:
После завершения работы с отчетом
необходимо выбрать пункт меню «Файл», далее выбрать пункт «Закрыть».
Ресурсы,
расходуемые на операцию:
15 секунд.
Задача:
«Формирование табличных и графических форм отчетности»
Заполняется по аналогии.
5. Аварийные ситуации
В разделе «Аварийные
ситуации» указывают: 1. действия в случае несоблюдения условий выполнения
технологического процесса, в том числе при длительных отказах технических
средств; 2. действия по восстановлению программ и/или данных при отказе
магнитных носителей или обнаружении ошибок в данных; 3. действия в случаях
обнаружении несанкционированного вмешательства в данные; 4. действия в других
аварийных ситуациях.
В случае возникновения ошибок при
работе ИАС КХД, не описанных ниже в данном разделе, необходимо обращаться к
сотруднику подразделения технической поддержки ДИТ (HelpDesk) либо к
ответственному Администратору ИАС КХД.
Класс ошибки |
Ошибка |
Описание ошибки |
Требуемые |
Портал ИАС КХД |
Сервер не найден. |
Возможны проблемы с |
Для устранения проблем с |
Ошибка: Требуется ввести |
При регистрации на |
Ввести имя пользователя. |
|
Ошибка: Требуется ввести |
При регистрации на |
Ввести пароль. |
|
Ошибка: Сбой |
Неверно введено имя |
Нужно повторить ввод |
|
Сбой в электропитании |
Нет электропитания |
Рабочая станция |
Перезагрузить рабочую |
Сбой локальной сети |
Нет сетевого |
Отсутствует возможность |
Перезагрузить рабочую |
6. Рекомендации по освоению
В разделе «Рекомендации по
освоению» указывают рекомендации по освоению и эксплуатации, включая
описание контрольного примера, правила его запуска и выполнения.
Рекомендуемая литература:
· Oracle® Business Intelligence Discoverer
Viewer User’s Guide
· Oracle® Business Intelligence Discoverer
Plus User’s Guide
Рекомендуемые курсы обучения:
· Discoverer 10g: Создание запросов
и отчетов
В качестве контрольного примера
рекомендуется выполнить операции задачи «Визуализация отчетности», описанные в
п. 4.2. настоящего документа.
Ход
работы:
Задание 1.
Изучите
свой вариант руководства пользователя. Опишите его по следующему плану:
1) для
какого продукта, предназначено руководство пользователя (наименование, модель);
2)
основные технические характеристики продукта;
3)
основные разделы руководства пользователя (название раздела и краткое его
описание)
Задание 2.
Откройте
документ «Образец руководства пользователя», заполните в нем первые разделы для
своего вымышленного программного продукта.
Сделайте
вывод
о проделанной работе.
Контрольные
вопросы:
1) Дайте
определения понятиям «руководство пользователя», «инструкция по эксплуатации»
2) Какие
основные разделы должно содержать руководство пользователя?
3) Какие
стандарты описывают Руководство пользователя Руководство оператора, Руководство
программиста, Руководство системного программиста?
4) Что
описывает раздел «назначение системы»?
5) Что
указывается в разделе «условия применения системы»?
6) Какая
информация содержится в разделе «Описание операций»?
Как написать руководство пользователя программы или сайта — инструкции, советы, помощь, программное обеспечение
Журавлев Денис
Что такое руководство пользователя и для чего его создавать
Ежедневно создаются новые продукты, программы, сервисы и часто пользователям приходится несладко при освоении какой-нибудь сложной программы, поэтому каждому новому продукту желательно собственное руководство. Для чего?
Большинство людей не хочет разбираться с чем-то незнакомым без персонального, всегда доступного и понятного помощника. А именно им и является хорошее руководство пользователя.
Общие советы по созданию пользовательской документации
Перед тем как приступить к созданию руководства, нужно определиться с некоторыми важными моментами. Например, определить, для кого вы его пишете? Кто его будет читать — рядовые пользователи, для которых важны базовые функции продукта, или люди, которым нужны особые, нечасто используемые функции программы/сервиса.
После этого важно подумать о том:
- Где пользователь будет к нему обращаться: дома, на работе, в машине?
- Как часто он будет его просматривать?
- Насколько объективно сложен для понимания продукт?
Из этого можно сделать вывод, насколько интенсивно пользователь будет работать с документацией, а значит уже можно выбрать между сжатым «справочником» или объемным «путеводителем» Также важно, чтобы руководство писал профессионал, знающий продукт. Так что по возможности делегируйте написание техническому специалисту или аналитику, у которого есть полное представление о всех тонкостях продукта.
Определившись со всеми представленными пунктами, станет понятнее, какой нужно использовать стиль изложения, какого объема написать текст. Но помните, что излишне стилистически окрашенные слова мешают пользователю добраться до сути. Так что лучшим вариантом в большинстве случаев будет нейтрально-формальный стиль. Пишите так, чтобы пользователь вас понял. Постарайтесь по возможности избегать технических терминов, но проанализируйте — не сделает ли полное отсутствие терминов ваше руководство бесполезным?
Структура руководства пользователя
После того как вы ответили на предыдущие вопросы, создайте структуру руководства. У любого хорошего «путеводителя» хорошая и логичная структура. Начните с оглавления. Информативное содержание поможет читателю легко ориентироваться в документе.
В первом разделе желательно рассказать общую информацию о программе:
- Для чего создан продукт.
- Какие задачи он решает.
- Какие основные выгоды от использования для клиента.
В следующем разделе можно указать основные элементы пользовательского интерфейса. Пользователю будет трудно разобраться в софте, если он не поймёт для чего служат различные элементы интерфейса, или он не разберётся в основных режимах работы ПО. Опишите понятным языком предназначение экранов и окон.
Создайте раздел, где расскажете о наиболее эффективных способах применения продукта для решения типовых задач. Какие цели стоят перед клиентом, и как ваша программа/сервис помогает достичь их. Укажите информацию о том, как быстро и продуктивно пользоваться программой.
Ни одно руководство не обойдется без таких разделов как: «Частые вопросы» и «Устранение типовых проблем» В них разбираются вопросы и проблемы, с которыми часто сталкиваются пользователи. Для заполнения данного раздела вам скорее всего понадобятся уже готовые отзывы клиентов. Если у вас абсолютно новый продукт, вы можете предугадать проблемы ваших клиентов либо на первое время не включать данный пункт в ваше руководство.
Иногда технические писатели забывают о важном моменте в руководстве пользователя — контактная информация. Этот раздел поможет пользователям связаться с вами, даже если у них нет никаких вопросов и руководство полностью закрывает все их потребности. Клиент может дать совет, поделиться опытом или предложить выгодное вам сотрудничество.
Инструменты для быстрого создания руководства пользователя
Но как создать руководство пользователя, если пишешь его впервые? Или что делать, если руководство пользователя нужно постоянно обновлять и дорабатывать? Или нужны особые функции, которых нет в традиционных текстовых редакторах, например, в MS Word.
Одним из популярных инструментов для создания качественного руководства является программа Dr. Explain (https://www.drexplain.ru), в которой уже есть готовые шаблоны руководств пользователя с готовой структурой разделов и в которой удобно обновлять документацию, как бы часто эти обновления не происходили.
Видео-обзор основных возможностей программы Dr.Explain
Удобной особенностью инструмента является возможность экспортировать один и тот же документ в форматы: HTML, CHM, PDF. Простой и понятный интерфейс сам подскажет, как быстро просмотреть документ в различных форматах и настроить его под вывод в эти форматы.
Любой проект в Dr.Explain вы можете создать с нуля или импортировать уже существующую документацию, например из формата MS Word, HTML или CHM-файла, и буквально за несколько минут создать из нее онлайн-помощь, файл справки в формате CHM, или документ в формате PDF.
При создании руководства важно опираться на заранее составленный план. Дерево проекта в Dr.Explain поможет структурировать документ по вашему усмотрению. Вы можете добавлять, удалять перемещать разделы и переименовывать их. Для каждого раздела вы можете определить, в какой формат он будет экспортироваться. Также в работе удобно использовать статусы готовности разделов.
У программы свой собственный редактор, оптимизированный под работу со сложной документацией. Основные функции редактора вынесены в компактный тулбар. Это — управление стилем текста, форматирование абзацев, вставка ссылок, изображений, видео, таблиц и списков, а также вставка специальных объектов. Dr. Explain экономит время и силы своих пользователей. Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста и прибегают к очевидным решениям — «Ctrl+c», Ctrl+v». Dr.Explain предлагает решение по повторному использованию контента — текстовые переменные. Это решение экономит время, когда нужно много раз использовать один и тот же текст, особенно, который может периодически изменяться — например, версия документируемой системы.
Многие российские компании сталкиваются с тем, что руководство пользователя нужно писать согласно ГОСТ 19 и ГОСТ 34. Dr.Explain активирует поддержку требований ГОСТ фактически одним кликом. Программа автоматически сформирует структуру обязательных разделов и установит требуемые параметры страницы, стили абзацев, списков и заголовков.
Часто техническим писателям при документировании пользовательского интерфейса приходится снабжать изображения пояснительными выносками. Для таких случаев программа поддерживает специальные графические объекты — аннотированные экраны. Чаще всего аннотируются скриншоты программ и страниц веб-сайтов. Уникальной особенностью Dr.Explain является автоматическая аннотация изображений, получаемых при захвате экранов с окнами программ или сайтов. Программа анализирует структуру окон и добавляет пояснительные выноски ко всем значимым элементам.
Кроме того, Dr.Explain позволяет нескольким авторам одновременно работать над проектом с использованием сервиса www.tiwri.com, учетную запись на котором можно создать бесплатно за пару минут. При внесении правок одним автором сервис блокирует редактируемые разделы проекта для изменения другими авторами. По окончании редактирования изменения отправляются на сервер, и блокировка снимается. Так несколько человек могут одновременно работать над различными разделами проекта без риска помешать друг другу.
Попробовать режим многопользовательской работы в Dr.Explain можно даже с бесплатной лицензией. Вы можете создать общий проект и полноценно работать с ним в многопользовательском режиме до семи дней.
Почему компании выбирают Dr.Explain для создания руководств пользователя
Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы «Вега Матрица»
«Только программа Dr.Explain обладала всеми необходимыми возможностями. А главное — она давала простор для творчества. Можно было выбрать цветовую гамму, вид и форму служебных элементов, настраиваемые шаблоны. Это позволило мне сохранить стилевое единство документации и самой программы. Ну, и конечно, полуавтоматическая обработка материала существенно облегчает и ускоряет работу по созданию хелпа.
Обучение работе в Dr.Explain было наглядным и сделано возможностями самой программы, что безусловно повлияло на мой выбор в ее пользу».
Прочитать полный кейс компании «Вега Матрица вы можете перейдя по ссылке
Наталья Обухова, бизнес-аналитик компании CRM Expert
«По классике жанра был пилотный проект на двух фаворитах (Dr.Explain и HelpNDoc) и муки выбора.
Через неделю справка была полностью готова. Конечно, если мы набивали ее «с нуля», за это время мы бы не успели. Мы просто конвертировали все бумажные инструкции во внутренний формат программ, изменили каталогизацию и организовали систему гиперссылок.
Сначала фаворитом выбора была другая система, но решающим фактором в пользу Dr.Explain стал возглас человека, выполняющего основную часть работы по переносу текста: «Вжух! И вся структура документа перенеслась в файл справки». Функция импорта в Dr.Explain отработала на ура и сэкономила кучу времени.
Также очень подкупил дизайн веб-справки, который формируется Dr.Explain, и красивый способ организации подписей к окнам нашей системы. В Dr.Explain это называется «Аннотирование экрана».
Возможность установки статуса раздела тоже оказалась очень удобной, особенно, после импорта старой версии справки легко отслеживать, какие разделы требуют обновления, в каких еще ведутся изменения, а какие уже обновлены и актуальны».
Прочитать полный кейс компании CRM Expert
Николай Вальковец, разработчик компании 2V
«Мы значительно сократили время работы техподдержки с новыми клиентами на этапе подключения. Раньше требовалось проводить онлайн презентации и видео конференции для новых клиентов, объясняя особенности программы. Сейчас же, один раз постаравшись максимально подробно всё описать, мы избавили себя и нашу техподдержку от этой работы. Нам импонирует простота программы и скорость работы. Можно быстро редактировать, добавить новые пункты в документацию, сохранить в формате HTML и выложить на сайт».
Прочитать кейс компании V2
Подытожим
Создание и написание хорошей пользовательской документации — это труд, который требует много времени и усилий. Но если успешно справиться с задачей, можно навсегда получить лояльных и довольных клиентов. Не забывайте о том, что недовольство от некачественного руководства может быть спроецировано пользователем на сам продукт и повлиять на дальнейшие решения о его выборе. Пользовательская документация должна стать персональным и незаменимым помощником. Используя Dr. Explain, вы сможете быстро создать качественное руководство пользователя, которое будет помогать пользователям разбираться в продукте, а вам позволит сосредоточить свои силы на более важных задачах — разработке и продвижении программного продукта.
Скачать Dr.Explain с неограниченной по срокам возможностью бесплатной работы можно по адресу: https://www.drexplain.ru/download/
Успешных вам разработок!
Смотрите также
- Dr.Explain — инструмент для создания мобильной версии пользовательской документации к программным продуктам
- Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации