Библиотека, читать онлайн, скачать книги txt

БОЛЬШАЯ БИБЛИОТЕКА

МЕЧТА ЛЮБОГО


Руководство оператора гост

Существует множество видов предоставления справочной информации пользователю — это и FAQ frequently руководство оператора гост questions, часто задаваемые вопросы и онлайн справка и руководство пользователя user guide и популярные сегодня подсказки coachmarks, см. Существуют разные причины, по которым требуется написать руководство пользователя системы. Начиная с просьб заказчика в моей практике был случай, когда заказчику надо было поставлять руководство пользователя после каждой итерации, чтобы с его помощью он смог бы провести приемочное тестирование функциональности итерации и заканчивая условиями контракта, касающимися поставки готового ПО, если говорить о разработке ПО на заказ. В случае разработки собственного продукта написание руководства пользователя тоже часто имеет место. К созданию руководства часто привлекают аналитика, если нет возможности поручить техническому писателю. В подавляющем большинстве случаев самыми полными знаниями о системе обладает именно аналитик, он же обладает умением ясно излагать свои мысли в письменной форме в силу специфики профессии. Поэтому, мне не однократно приходилось сталкиваться с созданием руководство оператора гост пользователя. Ниже я приведу несколько практик для составления хорошего руководства пользователя. Часть из них, возможно, кому-то будут полезны и при написании спецификаций требований. Стандарты Часто бывает нужно написать документ, который бы удовлетворял требованиям действующих стандартов. Это могут быть: IEEE Std 1063-2001, «IEEE Standard for Software User Documentation»; ГОСТ 19: ГОСТ 19. Описание программы; ГОСТ 19. Требования к содержанию и оформлению; ГОСТ 19. Требования к содержанию и оформлению; ГОСТ 19. Требования к содержанию и оформлению; ГОСТ 19. Требования к содержанию и оформлению. Если потребности проекта позволяют вам не следовать жестким стандартам, в любом случае изучение этих документов может послужить стартовой точкой для написания качественного документа. Также может оказаться руководство оператора гост книга Юрия Кагарлицкого Руководство для разработчиков технической документации к программному обеспечению. Структура Хорошо продумайте структуру документа: она должна покрывать все функциональные возможности системы, быть полной и понятной. Хорошее руководство пользователя должно содержать: Аннотацию, в которой приводится краткое изложение содержимого документа и его назначение. Также рекомендуется писать краткую аннотацию в начале каждого крупного раздела. Введение, содержащее информацию о том, как лучше всего использовать данное руководство Содержание Главы, описывающие, как использовать ПО Глоссарий и Предметный указатель Также руководство пользователя может содержать: FAQ и ответы на них Ссылки на дополнительную информацию по системе Раздел, описывающий возможные проблемы и пути их решения Все главы и пункты, а также рисунки и руководство оператора гост лучше нумеровать, чтобы на них можно было сослаться внутри этого документа или руководство оператора гост другого документа. Пользователи Подумайте о типичных пользователях данного ПО: необходимо, чтобы документ помогал им решать их насущные задачи. Возможно, даже имеет смысл сделать разные разделы или даже разные документы для разных групп пользователей, если их взаимодействие с системой будет кардинально различаться. Например, администраторов системы людей, отвечающих за учетные записи, права доступа и т. Уважайте пользователей системы, не руководство оператора гост инструкции в пренебрежительном стиле. Особенности изложения Помните, что в устной речи или в деловом письме отличается от оного в технической документации, и в частности, в руководстве пользователя. Стиль руководства должен быть нейтрально-формальным — использование стилистически окрашенных слов отвлекает пользователя от сути. Для составления хорошего документа пригодятся знания грамматики и немного психологии. Не давайте лишних деталей, не дублируйте информацию. Последовательность упоминания информации в руководстве пользователя должна совпадать с последовательностью действий пользователя: Хорошо: In File руководство оператора гост, select Save item. Хуже: Select Save item from File menu. Хорошо : Click Logout to log out current user account from the system. Хуже : It is needed to click Руководство оператора гост to log out current user account from the system. Хуже : If user wants to log out current user account from the system s he needs to click Logout. Часто можно встретить совет, что надо стараться избегать списков, однако, структурированная по шагам информация всегда лучше воспринимается. Хорошо: To руководство оператора гост project : Click the Create button on toolbar. On the Create Project overlay fill in all mandatory fields. Click the Save button to save the project. Хуже : To create project click the Create button on toolbar, on the Create Project overlay fill in all mandatory fields, click the Save button to save the project. Например, часто встречаются руководства, в которых руководство оператора гост системы на действие пользователя передается фразами, сформулированными в будущем времени. У ПО нет прошлого или будущего: всё случается в настоящем как прямой результат конкретного действия пользователя. Как только событие случается, ПО реагирует. Хорошо : When user clicks the Start button, the program starts the process. Хуже: When user clicks the Start button, the руководство оператора гост will start the process. Если необходимо писать документ на иностранном языке, надо стараться максимально избегать ошибок, связанных руководство оператора гост недостаточным знанием языка. Например, глагол «press» означает нажатие клавиши на клавиатуре, а «click» — нажатие кнопки или значка в окне программы при руководство оператора гост мыши, а «hit» вообще является жаргонным словом. Разумеется, орфографические ошибки недопустимы. В IT литературе на английском или любом другом языке есть стандартный набор глаголов, обозначающих действия click, double-click, select, type, press и т. Определитесь с терминологией и придерживайтесь ее в рамках всего документа. Например, не допускайте, чтобы руководство оператора гост одной части документа выпадающий список назывался dropdown, а в другой точно такой же элемент — combobox или dropdown list. Считается, что сокращения использовать не стоит, но если длинный термин употребляется несколько раз, то при первом упоминании в тексте надо писать полное название и рядом — аббревиатуру в скобках, а далее по тексту можно использовать только аббревиатуру. Если в документе есть глоссарий или раздел с сокращениями, они должны быть там расшифрованы. Не используйте жаргонные слова, метафоры и термины, заимствованные из языка отличного от языка руководства. Это может быть корпоративный шаблон или цветовая схема ПО или специально сделанный для документа дизайн. При написании не стесняйтесь выделять важные вещи стилями или цветами например, названия кнопок выделять жирным шрифтом. Но важно понимать, что неправильно подобранные шрифты и цвета могут затруднить восприятие содержимого документа. Это облегчит восприятие прочитанной пользователем информации. Существует мнение, что не стоит увлекаться иллюстрациями, а также включать в текст пиктограммы icons в руководстве пользователя. Однако графическая информация всегда лучше воспринимается и запоминается, поэтому снимки экрана и нужные пиктограммы должны присутствовать в хорошем руководстве в достаточном, но разумном количестве. Поддержка Не упускайте из виду тот факт, что ПО со временем меняется, а значит, ваш документ тоже должен меняться, чтобы оставаться актуальным. Заключение Примите к сведению, что раздражение от некачественного документа может быть спроецировано пользователем на ПО и, тем самым, повлиять на решение использовать продукт. Помните главное: документ должен помогать пользователям. Статью подготовила Тарасюк Надежда, участник сообщества analyst. Статья понравилось, все четко и по полочкам как и должно быть в руководстве Единственное, статья ориентирована руководство оператора гост англоязычные версии инструкций, а наш великий и могучий имеет все же свою специфику. В частности, очень сложно придерживаться исключительно настоящего времени. Например как сформулировать руководство оператора гост в настоящем фразу а-ля «При нажатии на кнопку «Отправить», адресату будет направлено уведомление Чтобы отправить уведомомление адресату, нажмите кнопку «Отправить» ». И как быть если все же отклик на событие нажатие кнопки, сохранение происходит не единомоментно, а с некоторой задержкой? Еще меня интересует объем инструкции, где та золотая середина между количеством и качеством? Объем инструкции, как мне кажется, не будет играть столь важного значения, если в этой инструкции будет продумана навигация. Такую серьезную «телегу» написала такая милая девушка. Спасибо за FAQ по руководству, особенно пункт 4.



copyright © moskvapropiska.ru