Руководство пользователя

Руководство пользователя, руководство по эксплуатации, руководство оператора – документ, назначение которого – предоставить людям помощь в использовании некоторой системы. Документ входит в состав технической документации на систему и, как правило, подготавливается техническим писателем.

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

Типичное руководство пользователя содержит:

• Аннотацию, в которой приводится краткое изложение содержимого документа и его назначение

• Введение, содержащее ссылки на связанные документы и информацию о том, как лучше всего использовать данное руководство

• Страницу содержания

• Главы, описывающие, как использовать, по крайней мере, наиболее важные функции системы

• Глава, описывающая возможные проблемы и пути их решения

• Часто задаваемые вопросы и ответы на них

• Где ещё найти информацию по предмету, контактная информация

• Глоссарий и, в больших документах, предметный указатель

Руководство пользователя разрабатывается на основе стандарта РД 50-34.698-90 АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ.

Заключение

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

Выводы заключения должны приводиться в последовательности, соответствующей их значимости: первым должен быть указан наиболее глобальный вывод, отражающий главный результат работы, а последующие должны его развивать и уточнять. Выводы должны быть информативными, т.е. должны нести информацию о сути, взаимосвязях, физической трактовке взаимодействия изученных факторов.

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

При подготовке заключения наиболее распространенной ошибкой является подмена выводов информацией о проделанной работе. В этой связи при подготовке заключения нельзя допускать в тексте такие фразы как: «проведен анализ…», «сформулированы требования» и т.д., ограниченные только названием и не наполненные раскрытием сути, смысла соответствующих понятий.

Порядок защиты курсового проекта

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

Сразу после согласования задания студент приступает к подготовке пояснительной записки. По каждой главе выполняется сбор и анализ литературных источников, формулируются и описываются результаты.

Согласно заданию на курсовой проект руководителю в середине семестра предоставляется для обсуждения и проверки первая часть работы.

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

Срок выполнения проврки не должен превышать трех дней. В результате проверки проводится допуск студента к защите курсового проекта и указываются замечания к работе, которые студенту необходимо исправить. Если студент не успевает в установленный срок исправить указанные руководителем замечания, то дата защиты переносится на период пересдач академических задолженностей.

Защита студентом КП проходит публично в виде презентации в присутствии своих коллег.Итоговая оценка за презентацию складывается из оценки за выступление и оценки за ответы на не менее чем три вопроса по теме выполненной работы. Если студент неудовлетворительно подготовил презентацию или не ответил ни на один вопрос, то защита переносится на период пересдач академических задолженностей.