Примеры и рекомендации удобных инструкций / Хабр
Снова здравствуй, уважаемый хабралюд!В продолжении своего поста решил написать, как лучше всего создавать инструкции для пользователей и администраторов.
Всем, кому интересно, прошу под хабракат.
KISS
Принцип Keep It Simple Stupid хорошо известен в программировании, но почему-то его редко используют для написания инструкций и руководящих документов, предпочитая растекаться мыслею по древу. В 70% ситуаций эта документация необходима только для того, что бы отмахаться от наших бодрых регуляторов, но при этом забывают, что с этой документацией придётся работать, причём не всегда технически подкованным и грамотным в области информационной безопасности людям.
Для начала напишу несколько правил, которые помогут создать рабочий и удобный документ:
1. Старайтесь разделять инструкцию для пользователей от инструкции для администраторов и офицеров безопасности. причём первые не должны содержать ссылок на вторые (они могут содержать отсылки друг к другу).
2. Делайте пошаговые инструкции, вида «взял и сделал». То есть инструкции должны описывать алгоритм действий того, на кого она направлена.
3. Каждый пункт описывайте, как отдельное действие с обязательным указанием ответственного и контактами, если они необходимы.
5. Психологический момент — инструкция будет плохо выполняться и работать, если пользователям понятно и доступно не объяснят алгоритм на пальцах и примерах. Поэтому — НЕ ЗАБЫВАЙТЕ ПРО ОБУЧЕНИЕ!
Пример инструкции для пользователей
Ниже приведен пример инструкции по заведению аккаунта пользователя в корпоративной сети.
Clear screen/clear desk
Специфика российских организаций, работающих с советских времен и таких же умудренных опытом сотрудников такова, что у них, как правило, стол завален бумагами. Компьютер порой не выключается и не блокируется, даже когда уходят домой. Недавно лично видел, проходя поздно вечером мимо одного муниципального предприятия, как за открытыми жалюзи в закрытом на замок здании горел монитор с открытым на нём вордовским документом.
Пользователи порой не догадываются о возможных непреднамеренных утечках информации. Пускай она не конфиденциальна, возможно она только для внутреннего пользования. Но это даёт понимание, что в этой организации не заботятся о своей безопасности и могут так поступить с конфиденциалкой. А так же возможно там будет информация, ещё не отнесенная к закрытой, но уже существующая во внутреннем обороте организации.
Хорошим примером из лучших практик здесь является политики чистого стола и чистого экрана. Их можно описать так же, как я приводил пример ранее, но это будет выглядеть немного глупо, так как действия там простейшие. Лучше просто сделать набором правил:
На этом завершаю примеры и рекомендации. Серию подобных постов я продолжу, если будет интерес.
P.S. В посте приведены скрины реально внедренных и работающих инструкции и политик. Все совпадения с существующими организациями случайны. Все названия отделов и бюро изменены.
создание пошаговых инструкций и руководств
В данном видео рассмотрим один, на первый взгляд незаметный, инструмент, который появился в Windows 7. Под названием Problem Screen Recorder, что на русский переводится как запись проблем с экрана.
Это небольшая утилита, которая позволяет делать скрин ксты с монитора и изначально она предназначалась для того, чтобы при появлении определенных неполадок в работе, можно было отправить получившийся файл в службу технической поддержки, чтобы было более наглядно продемонстрирована проблема.
Но лично я её чаще использую для составления инструкций и руководств, как для пользователей, так и для самого себя, чтобы в случае какой-то ситуации, можно было открыть собственноручно составленную инструкцию и быстренько все вспомнить, что к чему (не используя туже Camtasia Studio).
И так, давайте разберемся, что же данная утилита из себя представляет.
Запускается программа командой Выполнить \ psr
Появляется небольшое окошечко под названием Средство записи действий по воспроизведению неполадок. Программа настолько проста, что состоит всего лишь из кнопок Начать запись, Остановить запись и Добавить комментарий.
Чтобы настроить программу щелкаем на значок треугольника и в всплывающем меню выбираем параметры, а параметра тут всего 3. Это расположение получившегося файла в результате записи, но это расположение можно не задавать, так как в конце записи программа сама спросит куда сохранить. Включить снимки экрана, жмем Да, так как собственно для этой цели данная программа нам и нужна, и число хранимых снимков экрана (по умолчанию 25, а максимум 100) Советую ставить максимальное значение, так как если будет сделано больше 25 снимков, допустим 30, то первые 5 сделаных снимка, пропадут, по этому лучше сразу выставлять максимальную планку.
По мимо использования данной программы как средства уточнения своей проблемы перед технической поддержкой, её можно использовать для быстрого составления инструкций и технических руководств для персонала. Допустим у вас в организации внедряется новое программное обеспечение и чтобы как можно быстрее и удобнее обучить персонал работе с ней, резонно составить инструкцию. Делать это через кнопку принт скрин (фотография рабочего стола) и постоянно вставлять эти скрины не удобно, по этому нам и поможет данная программа.
Как сделать буклет в Ворде. Пошаговая инструкция по созданию буклетов в Word
Буклетом принято называть лист бумаги A4 сложенный в два раза. Буклеты могут использоваться для информирования клиентов или сотрудников компании о продукции или запланированном мероприятии.
Для того чтобы профессионально сделать буклет необходимы специальные программы и навыки дизайнера, но простую версию буклета вполне можно сделать при помощи обычного текстового редактора Word и минимальных навыков. Именно об этом мы и расскажем в данной статье в виде пошаговой инструкции о том, как сделать буклет в Word.
Шаг № 1. Смените ориентацию страницы на альбомную.
Для того чтобы сделать буклет в Ворде сначала необходимо сменить ориентацию страницы с книжной на альбомную. Это делается для того чтобы была возможность набирать текст вдоль листа. Для этого перейдите на вкладку «Разметка страницы», нажмите на кнопку «Ориентация» и выберите вариант «Альбомная».
Шаг № 2. Уменьшите отступы от края листа.
Дальше необходимо уменьшить отступы от края листа. Если этого не сделать, то буклет будет обрамлен в большую белую рамку, и это будет выглядеть не очень привлекательно. Поэтому на той же вкладке «Разметка страницы» нажимаем на кнопку «Поля» и выбираем вариант «Узкие». При выборе данного варианта будут использоваться поля размером в 1.27 сантиметра с каждой стороны.
Обычно поля размером в 1.27 сантиметра отлично подходят для создания буклетов. Но, если хотите еще меньшие поля то выберите вариант «Настраиваемые поля».
После этого появится окно «Параметры страницы» в котором вы сможете выставить нужные размеры полей для каждой стороны листа.
Шаг № 3. Разделите лист бумаги на три колонки.
После того, как вы настроили поля, необходимо разделить лист бумаги на три части. Для этого на той же вкладке «Разметка страницы» нажимаем на кнопку «Колонки» и выбираем вариант «Три».
После этого лист бумаги будет разделен на три части. Вы сможете заметить это по изменению линейки над листом.
необходимо отметить, что переход на вторую колонку будет возможен только после того, как первая будет заполнена текстом. Для того чтобы решить эту проблему можете просто нажать на клавишу Enter и заполнить страницу большим количеством переносов строки.
Шаг № 4. Настройте разделитель и другие параметры буклета.
Если есть необходимость, то вы можете добавить разделитель между колонками сделанного вами буклета. Для этого снова нажмите на кнопку «Колонки» и выберите вариант «Другие колонки».
После этого появится небольшое окно с настройками буклета. Здесь необходимо просто установить отметку напротив функции «Разделитель». необходимо отметить, что разделитель появляется только в том случае, если все колонки буклета заполнены текстом до конца. Пока буклет пуст, разделитель не отображается.
Также в окне «Колонки» можно настроить ширину колонок буклета и промежуток между ними. При необходимости можно даже сделать колонки разной ширины. Для этого необходимо снять отметку напротив функции «Колонки одинаковой ширины» и задать значение ширины для каждой колонки вручную.
В конце не забудьте сохранить настройки нажатием на кнопку «Ok».
Как сделать буклет с большим количеством колонок
Если вы хотите сделать буклет с более чем тремя колонками, то это также можно сделать с помощью текстового редактора Word. Для этого нажмите на кнопку «Колонки» на вкладке «Разметка страницы» и выберите вариант «Другие колонки».
После этого установите необходимое количество колонок для вашего буклета.
И нажмите на кнопку «Ok» для того чтобы сохранить настройки.
Как сделать буклет в Microsoft Word | How to make a booklet in Microsoft Word
Как создать ТОС? Пошаговая инструкция
Уважаемые друзья!
Если вы открыли данную статью, значит у вас есть практический интерес к созданию территориального общественного самоуправления или проще — ТОС.
Цель данной статьи: помочь активным гражданам организовать ТОС для реализации их инициатив по улучшению качества жизни по месту жительства.
В статье представлены как описание всех этапов в создании ТОС ( с образцами документов для решения всех промежуточных задач и взаимодействия с органами местного самоуправления и органами государственной власти), так и даны ответы на наиболее насущные вопросы, а также практические советы по наиболее эффективной организации работы.
Вопросы и советы выделены и помещены в рамочки. Если у Вас нет этих вопросов или Вы не нуждаетесь в советах – просто пропускайте данную информацию.
Представленные в приложении образцы документов не являются догмой, но они подготовлены для помощи Вам в подготовке обязательных документов. Это только образцы, в которые Вы можете вносить свои изменения. Ограничением являются только обязательные требования, если в представленных образцах они содержатся, то перед каждым документом будет дано пояснение по этому вопросу.
Не бойтесь трудностей, их немного и они все преодолимы!
ТОС может быть создано и зарегистрировано в двух вариантах:
- Без создания юридического лица.
В этом случае регистрация ТОС проводится только в органах местного самоуправления. Но в этом случае для реализации Ваших инициатив могут использоваться только собственные ресурсы (средства самих жителей), а также средства на поддержку ТОС, если они предусмотрены в бюджете вашего муниципального образования).
Если Вы выбрали этот вариант создания ТОС, то данная пошаговая инструкция Вам пригодится в первой своей части (шаги 1-5).
- Создание ТОС, с регистрацией в качестве юридического лица. Если Вы решили идти дальше и регистрировать ТОС как юридическое лицо в форме НКО (некоммерческая организация), то Ваши дальнейшие шаги на этом пути полностью описаны в этой брошюре (шаг 6 – 7).
|
Ниже описаны все практические шаги, необходимые для образования ТОС. Описание подготовлено на основе опыта действующих ТОС, а также норм законодательства. Образцы всех необходимых документов и форм представлены в приложениях.
ШАГ 1. ОБРАЗОВАНИЕ ИНИЦИАТИВНОЙ ГРУППЫ
Создание ТОС начинается с создания и официального признания инициативной группы. Количество членов инициативной группы может быть любым, но не менее 3 человек, проживающих на территории создаваемого ТОС и достигших 16-летнего возраста.
|
Образование инициативной группы оформляется протоколом собрания инициативной группы по созданию ТОС (образец – приложение 1).
В протоколе обозначена повестка собрания. Как правило, на этом собрании обсуждаются следующие вопросы:
- Избрание председателя и секретаря собрания (необходимы для оформления протокола и его представления в органы местного самоуправления).
- Формирование инициативной группы для проведения мероприятий по созданию ТОС.
- Подготовка предложений по наименованию ТОС, по границам ТОС, по проекту Устава ТОС, по структуре и составу совета ТОС, по кандидатуре председателя совета ТОС.
- Организация работы по проведению учредительного собрания граждан по образованию ТОС.
Проведите собрание, обсудите последовательно все вопросы, из которых содержательно важными (то есть требующими вдумчивого обсуждения) являются третий и четвертый.
Заполните протокол в соответствии с повесткой. Этот документ является самым первым, который необходим для образования ТОС.
| ||||
| ||||
Проект Устава – приложение 2.
|
ШАГ 2. УСТАНОВЛЕНИЕ ГРАНИЦ ТОС И НАЗНАЧЕНИЕ ДАТЫ ПРОВЕДЕНИЯ УЧРЕДИТЕЛЬНОГО СОБРАНИЯ, КОНФЕРЕНЦИИ
Вы провели собрание инициативной группы, на котором обсудили свои предложения границах будущего ТОС. У вас имеется соответствующий протокол. Теперь, чтобы утвердить границы ТОС, необходимо подать заявление в представительный орган (совет депутатов, думу) местного самоуправления (образец – приложение 3).
Представительный орган на основе заявления инициативной группы должен принять Решение об установлении границ, которое позволит начать практическую работу по организации учредительного собрания или конференции.
После получения Решения представительного органа об утверждении границ ТОС, инициативная группа принимает решение о назначении даты и времени проведения и месте проведения учредительного собрания /конференции.
|
ШАГ 3. ИЗВЕЩЕНИЕ ЖИТЕЛЕЙ ТЕРРИТОРИИ И ОРГАНОВ МЕСТНОГО САМОУПРАВЛЕНИЯ О ПРОВЕДЕНИИ УЧРЕДИТЕЛЬНОГО СОБРАНИЯ ИЛИ КОНФЕРЕНЦИИ ГРАЖДАН
Необходимо проинформировать население о дате, месте и времени проведения собрания/конференции не менее чем за 15 дней до начала мероприятия. Сообщение о проведении учредительного собрания или конференции граждан должно быть направлено каждому жителю, достигшему 16 — летнего возраста, проживающему на территории создаваемого ТОС.
Также допускаются иные методы оповещения граждан об учредительном собрании или конференции граждан — объявления, подомовой/поквартирный обход.
Желательно проинформировать органы местного самоуправления о проведении учредительного собрания/конференции. В адрес органов местного самоуправления направляется письменное извещение, в котором указывается место, дата и время проведения собрания/конференции, а так же вопросы повестки дня.
Это подготовит их к регистрации устава ТОС и дальнейшему сотрудничеству с органами ТОС.
ШАГ 4. ПРОВЕДЕНИЕ УЧРЕДИТЕЛЬНОГО СОБРАНИЯ ИЛИ КОНФЕРЕНЦИИ ГРАЖДАН
Учредительное собрание или конференцию граждан проводит инициативная группа.
Как собрание, так и конференция проводятся открыто и на них могут присутствовать (не мешая работе) представители органов местного самоуправления, государственных органов, СМИ и другие заинтересованные лица.
Участвовать в принятии решения (голосовать) могут только жители территории на которой создается ТОС (достигшие 16 летнего возраста), а на конференции только делегаты, уполномоченные установленным числом жителей (по норме представительства). Поэтому при регистрации делегатов проверяются документы, удостоверяющие их полномочия (протоколы собраний, подписные листы), при этом обязательно заполняется ЛИСТ РЕГИСТРАЦИИ УЧАСТНИКОВ (приложение 6).
Учредительное собрание или конференция граждан считается правомочным при участии в нем не менее 30% жителей соответствующей территории, достигших 16-летнего возраста.
Ход и решения учредительного собрания/конференции граждан оформляются ПРОТОКОЛОМ (образец протокола учредительного собрания – приложение 7; образец протокола конференции граждан – приложение 8),
Как правило, на учредительном собрании/конференции
граждан рассматриваются следующие вопросы (повестка дня):
собрания:
- Об избрании Председателя и секретаря Собрания/конференции граждан.
- О создании территориального общественного самоуправления _________________ ( дописать название ТОС).
- О принятии Устава ТОС.
- Об основных направлениях деятельности ТОС на предстоящий период.
- Об избрании Совета ТОС.
- Об избрании Председателя ТОС (дописать название ТОС).
- Об избрании Ревизионной комиссии ТОС _______________ (дописать
название).
После проведения учредительного собрания или конференции необходимо заполнить протокол.
ШАГ 5. РЕГИСТРАЦИЯ УСТАВА ТОС В АДМИНИСТРАЦИИ МУНИЦИПАЛЬНОГО ОБРАЗОВАНИЯ
После проведения учредительного собрания или конференции граждан уполномоченное лицо (председатель ТОС) подает документы в администрацию муниципального образования для регистрации Устава ТОС:
- Заявление о регистрации устава ТОС.
Заявление подается на имя главы муниципального образования, подписанное председателем ТОС, с указанием Ф.И.О., адреса места жительства, и контактных телефонов.
- Копия решения представительного органа об установлении границ территории, на которой образовывается ТОС (см. шаг №2).
- Протокол учредительного собрания или конференции граждан (см. шаг №4).
- Два экземпляра Устава ТОС.
Экземпляры должны быть прошиты, страницы пронумерованы, подписаны заявителем на последнем листе каждого экземпляра.
- Лист регистрации участников собрания или конференции граждан с указанием их адресов и даты рождения (см. шаг №4).
- Список избранных членов инициативной группы с указанием адресов и телефонов (см. шаг №1).
Сроки регистрации Устава устанавливается Администрацией, но он не может превышать 30 дней.
Поздравляем! ТОС зарегистрирован! Вы может приступать к реализации своих планов и обращаться в органы местного самоуправления за поддержкой вашей деятельности!
Но в данный момент ТОС не является юридическим лицом. Дальнейшие шаги описывают регистрацию ТОС в качестве юридического лица.
ПРИЛОЖЕНИЯ – Документы для создания ТОС:
- Образец Протокола собрания инициативной группы по созданию территориального общественного самоуправления
- Типовой Устав территориального органа местного самоуправления
- Образец заявления в представительный орган об утверждении границ ТОС
- Подписной лист по выборам делегата конференции граждан.
- Информационная листовка об инициативе по созданию ТОС
- Лист регистрации участников собрания/делегатов конференции
- Образец протокола учредительного собрания
- Образец протокола конференции граждан
ШАГ 6. РЕГИСТРАЦИЯ ТОС В УПРАВЛЕНИИ МИНЮСТА РОССИИ В КАЧЕСТВЕ ЮРИДИЧЕСКОГО ЛИЦА
Для регистрации ТОС в Управлении Минюста России необходимо представить следующие документы:
- Заявление о государственной регистрации юридического лица по форме №P11001 (форма заявления и пояснения по его заполнению размещены на сайте управления юстиции по Хабаровскому краю и ЕАО: http://to27.minjust.ru)
- Учредительные документы, заверенные подписью председателя ТОС:
▪Устав ТОС (в 3 экземплярах).
▪Протокол учредительного собрания или конференции граждан (в 2 экземплярах).
- Квитанция об оплате государственной пошлины.
Устав и протокол учредительного собрания или конференции граждан должны быть подготовлены в результате прохождения предыдущих шагов.
Обратите внимание на некоторые нюансы при заполнении формы заявления:
- В заявлении необходимо указать трех учредителей ТОС.
- Подпись заявителя (председателя ТОС) должна быть нотариально заверена.
ШАГ 7. ЗАКЛЮЧИТЕЛЬНЫЙ ЭТАП
Как только вы получили все регистрационные документы необходимо:
- Сделать печать ТОС.
|
- В течение 30 календарных дней с момента регистрации подать заявление в налоговую на упрощенную систему налогообложения (УСН). Мы рекомендуем в заявлении выбрать объект налогообложения «доходы-расходы (15%)».
- Сдать в территориальный орган федеральной службы государственной статистики «Сведения о среднесписочной численности работников» — Форма по КНД 1110018.
Сведения необходимо сдать до 20–го числа месяца, следующего за месяцем регистрации. Так как работников нет, то численность ставите ноль.
- Открыть расчетный счет в банке.
Еще раз поздравляем Вас!
Теперь Вы полноправный хозяйствующий субъект и можете участвовать в грантовых конкурсах в качестве социально ориентированного НКО.
Как создать таблицу в Word: пошаговая инструкция для начинающих
Автор Вячеслав Вяткин На чтение 6 мин. Просмотров 1.1k. Опубликовано
Ещё одна полезная статья на нашем сайте расскажет о тонкостях работы с текстовым редактором Word. Последний давно стал незаменимым рабочим инструментом, позволяющий решить немало задач. Однако, важно при этом знать о его возможностях и уметь ими пользоваться. Сегодня поговорим о том, как сделать таблицу в «Ворде». Процесс довольно прост и справится даже начинающий пользователь. Главное, следовать нашим инструкциям, которые мы очень подробно распишем в статье.
Как сделать таблицу в «Ворде»
Если требуется упорядочить определённые данные или сравнить два объекта, на помощь придёт таблица. Чтобы её создать не требуется особых знаний. Главное, освоить простой алгоритм и знать, где находится нужный инструмент.
В верхней части экрана находится панель инструментов с различными разделами. В нашем случае необходимо перейти во вкладку «Вставка» и выбрать подраздел «Таблица». Откроется меню с несколькими инструментами. Разберёмся в каждом из них.
- Вставка таблицы — конструктор. Он выглядит как поле их ячеек, которое по умолчанию позволяет вставить область из 10 единиц по горизонтали и 8 по вертикали. Если таблица вписывается в предложенные рамки, то достаточно мышкой выделить нужную область, соответствующую количеству необходимых строк и столбцов. Результат мгновенно появится на странице.
- Если необходимо большее число ячеек по вертикали или горизонтали, поможет следующий инструмент «Вставить таблицу». После нажатия появится новое диалоговое окно, в котором требуется указать параметры таблицы (число строк и столбцов). Также можно скорректировать ширину столбцов и установить параметры расположения текста в ячейках. Затем подтверждаем свои действия кнопкой «Ок». При необходимости можно сохранить установленные настройки для автоматической конфигурации следующих таблиц.
- Следующий инструмент предлагает нарисовать таблицу. В этом случае в рабочей зоне появляется карандаш, который чертит линии, формирующие таблицу. Пользователь создаёт область расположения, а затем расчерчивает таблицу на нужно количество строк и столбцов. Независимо от художественных навыков, линии получаются ровными и перпендикулярными друг к другу.
- Следующий доступный инструмент — «Таблица Exsel». После нажатия в рабочей области текстового документа появляется таблица, соответствующая вышеуказанной программе и со всем доступным ей функционалом. Это будет полезно, если требуется быстро заполнить область таблицы данными, используя математические формулы.
- Последний пункт меню, о котором стоит поговорить, «Экспресс-таблицы». Здесь располагаются готовые шаблоны нестандартных решений. Например, календарные таблицы, готовые оформления с шапкой и так далее. Особенность этого раздела в том, что пользователь может пополнить шаблоны собственными, просто выделив часто используемый формат и сохранив его через это меню.
Вот все инструменты для создания таблицы, доступные пользователю. После этого описания можно было бы считать вопрос, как создать таблицу в «Ворде» исчерпанным. Однако, мы хотим рассказать нашим читателям еще несколько нюансов, чтобы пользы от прочтения было как можно больше.
Редактирование таблицы
В этом разделе мы разберёмся, как изменять таблицу, вставленную в текстовый редактор. Часто пользователю требуется не просто набор определённого количества строк и столбцов, но и некоторое форматирование. О нём и поговорим.
После вставки таблицы, пользователю становится доступным специальный блок в разделе инструментов в верхней части экрана. Называется он «Работа с таблицами» и включает в себя две вкладки «Конструктор» и «Макет». В первом можно задать собственные или выбрать готовые стили таблиц. Во втором доступны вставка, удаление, объединение ячеек, а также установка размеров и выравнивание данных и самой таблицы.
Важно! Чтобы блок «Работа с таблицей» появился в панели инструментов, необходимо выделить таблицу или поместить курсор внутрь ячейки. Все изменения в структуре необходимо проводить также предварительно, выделив весь объект или нужную область.
Объединение или разбивка ячеек
Нередко для создания шапки таблицы требуется объединить ячейки. Чтобы сделать это правильно, следуйте нашему алгоритму.
- Выделите область, требующую объединения с помощью мыши.
- В панели инструментов перейдите во вкладку «Макет» области работы с таблицами.
- В меню «объединение» нажмите на кнопку, открывающую выпадающее меню, и выберите нужное действие.
Аналогичным образом можно и разделить ячейки. Для этого достаточно выбрать соответствующую команду в выпадающем списке. После этого откроется диалоговое окно, в котором нужно указать, на какое количество строк и столбцов необходимо разделить выбранную область.
Эти инструменты позволяют быстро и без лишних проблем придать таблице нужную структуру.
Границы и заливка
Теперь поговорим о том, что делать, когда к вопросу, как создать таблицу в «Ворде» добавляется необходимость визуального выделения областей. В этом случае есть несколько вариантов: заполнение нужной области определённым цветом, выделение ячейки особым стилем границ.
Для того чтобы закрасить ячейку, потребуется инструмент «заливка». Чтобы воспользоваться им не обязательно переходить во вкладку «Макет». Найти его можно и в наборе инструментов главного раздела. Выглядит иконка как ведёрко с краской и полосой, определяющей выбранный цвет. Достаточно выделить нужную область и нажать на иконку, а затем выбрать цвет.
Совет! Для экономных. Если вы планируете распечатывать материал советуем выбирать более бледные решения цветовой гаммы (например, если требуется чёрная заливка, лучше отдать предпочтение серому цвету). Это позволит сократить расход краски в принтере.
Стиль границы ячейки устанавливается с помощью инструментов вкладки «Конструктор». Раскройте выпадающее меню раздела «Обрамление». Здесь можно не только особым образом выделить границы некоторой области таблицы, но и удалить или восстановить их. Это позволит придать объекту не стандартный прямоугольный, а особый вид.
Стоит отметить, что практически все описанные действия доступны через контекстное меню. Для этого достаточно выделить ячейки или всю таблицу, в зависимости от целей, и щёлкнуть правой кнопкой мыши. В открывшемся блоке инструментов будут представлены все доступные действия. Остаётся выбрать нужное и нажать на него.
Мы представили подробное руководство по работе и после прочтения статьи вопроса, как создать таблицу в «Ворде» не возникнет. Если у вас что-то не получается, возникли дополнительные вопросы или требуется сделать что-то, не вошедшее в статью – ждём в обсуждениях. Ответим на все вопросы. А вы, в свою очередь, делитесь статьей в социальных сетях и оставайтесь с нами.
Пошаговые инструкции по написанию — Microsoft Style Guide
- 2 минуты на чтение
В этой статье
Следуйте этим рекомендациям, чтобы помочь вам составить четкие и простые инструкции, пишете ли вы простые пошаговые процедуры или сложные процедуры, состоящие из нескольких шагов.
См. Также
Форматирование текста в инструкциях
Форматирование знаков препинания
Комплексные процедуры
Сложные инструкции часто состоят из нескольких шагов, отформатированных как нумерованный список.Для многошаговых процедур в нумерованных списках:
Единообразно форматируйте процедуры, чтобы клиенты могли легко их находить при сканировании.
Попробуйте использовать заголовок, чтобы помочь клиентам быстро найти инструкции. Используйте заголовок, чтобы рассказать клиентам, что инструкции помогут им сделать.
Примеры
Чтобы добавить счет
Добавить счетВыберите один стиль фразировки для заголовков и напишите их все одинаково (в параллельной структуре).
Используйте отдельные пронумерованные записи для каждого шага. Можно комбинировать короткие шаги, которые происходят в одном месте пользовательского интерфейса.
В большинстве случаев включает в себя действия, завершающие шаг, такие как кнопки ОК или Применить.
Используйте полные предложения.
Используйте формы повелительного наклонения. В инструкциях клиенты действительно хотят, чтобы вы указали им, что им делать.
Используйте согласованные структуры предложений.Например, всегда используйте фразу, когда вам нужно сказать клиенту, с чего начать. В остальное время каждое предложение начинайте с глагола.
Примеры
На ленте перейдите на вкладку Дизайн .
Открыть фото.
Для Выравнивание выберите Левый .Делайте первое слово на каждом этапе заглавным.
Используйте точку после каждого шага.
Исключение
При указании клиентам вводить данные без знаков препинания, не используйте точку.Попробуйте отформатировать текст чтобы вводимые пользователем данные появлялись в новой строке.Ограничьте процедуру семью шагами, а лучше меньше. Постарайтесь уместить все шаги на одном экране.
ПримерыДля создания группы плиток
- На начальном экране выберите плитки, которые хотите сгруппировать вместе.
- Перетащите их на открытое пространство. Когда за ними появится серая полоса, отпустите плитки, чтобы создать новую группу.
Для планирования спринтов
- В представлении Backlogs выберите первый спринт под Current .Или откройте свой бэклог спринта по следующему URL-адресу:
https: // AccountName / DefaultCollection / TeamProjectName / _backlogs / iteration
Несколько предопределенных спринтов перечислены в Current и Future . Фактические названия спринтов зависят от шаблона процесса, используемого для создания вашего командного проекта. Однако календарные даты не назначены. - Чтобы установить календарные даты, выберите первый спринт под Текущий и выберите даты.
Пошаговые процедуры
Если вы используете последовательный формат для пошаговых инструкций,
используйте тот же формат для пошаговых инструкций, но замените
номер с пулей.
Пример
Для перемещения группы плиток
- На начальном экране уменьшите масштаб и перетащите группу в нужное место.
Советы по написанию шагов
Прежде чем описывать действие, убедитесь, что клиент знает, где должно произойти действие.
Если инструкция отображается в том же пользовательском интерфейсе, где происходит действие, обычно нет необходимости указывать сведения о местоположении.
Если вам нужно убедиться, что покупатель начинает с нужного места, дайте короткую фразу в начале шага.
Пример
На вкладке Design выберите Header Row .Если есть вероятность путаницы, сделайте вводный шаг.
Пример
На ленте перейдите на вкладку Дизайн .
Простые инструкции с прямоугольными скобками
Для сокращения простых последовательностей используйте прямые угловые скобки. Включить пробел до и после каждой скобки, и не делайте скобки жирные.
Пример
Выберите Счета > Другие счета > Добавьте счет .
Совет по специальным возможностям Программы чтения с экрана могут пропускать скобки и читать такие инструкции, как Menu > Go To > Folders as Menu Go To Folders, , что может сбить с толку клиентов. Перед использованием этого подхода проконсультируйтесь со специалистом по специальным возможностям.
Step by Step — Плагин WordPress
Отображайте данные в пошаговом стиле с изображениями и с легкостью отображайте их в своем сообщении или на страницах за считанные минуты.Храните стандартный контент WYSIWYG отдельно от пошаговых инструкций для удобного редактирования.
Пошаговые особенности
- С легкостью создавайте пошаговые инструкции.
- Каждый шаг создается в отдельном модуле.
- Отдельный интерфейс для создания шагов.
- Используйте стандартный редактор WYSIWYG для фоновой информации.
- Укажите конкретное изображение для каждого шага.
- Укажите конкретный текст для каждого шага.
- Добавьте собственное описание для пошаговых инструкций.
- Размещайте «шаги» на страницах или публикуйте, используя короткие коды.
- Может использоваться для отображения всего, что требует пошаговых инструкций.
- Например, Руководства, процедуры, руководства, практические советы, математические инструкции, рецепты и многое другое.
### Pro — Характеристики ###
- Увеличение изображений в модальных окнах.
- Используйте встроенную функцию изображений WordPress для загрузки и хранения изображений.
- Аннотируйте и редактируйте изображения в браузере.
- Измените расположение ступеней в передней части на вертикальное, как в wikihow.com
- Добавить расширенную мета (ссылки, жирный шрифт и т. Д.) В область тела.
- Публикуйте прямо на отдельных страницах руководства без использования коротких кодов.
- Адаптивный макет.
- Пользовательские категории и ярлыки в URL.
Получить версию Pro.
Вы можете установить этот плагин одним из трех способов:
1. Админ. Поиск
- В панели администратора перейдите в меню Плагины> Добавить.
- Найдите
Шаг за шагом. - Найдите плагин с меткой
Step by Step. - Найдите в плагине имя автора
kmb40. - Щелкните, чтобы установить.
- Активируйте плагин.
- Новый пункт меню
Pin It Buttonпоявится в админке.
2. Загрузить и выгрузить
- Загрузите плагин (zip-файл) в правом столбце этой страницы.
- В панели администратора перейдите в меню Плагины> Добавить.
- Выберите вкладку «Загрузить».
- Загрузите только что загруженный файл .zip.
- Активируйте плагин.
- В вашем админке появится новый пункт меню
Step by Step.
3. Загрузка по FTP
- Загрузите плагин (файл .zip) в правом столбце этой страницы.
- Разархивируйте содержимое ZIP-файла.
- Загрузите папку
step-by-stepв каталог/ wp-content / plugins /вашего сайта. - Активируйте плагин через меню «Плагины» в WordPress.
- Новый пункт меню
Guidesпоявится в вашем меню в разделе администратора.
Использование
Для получения полных инструкций по использованию посетите страницу справки по адресу kylembrown.com/step-by-step
В. Как мне получить шаги на странице или в публикации?
A. После создания и сохранения шагов в интерфейсе «Руководства» автоматически создается шорткод. Этот шорткод можно разместить в сообщении или на странице.
В. Могу ли я размещать фотографии на каждом этапе?
А. Да.
В. Работает ли это внутри стандартного интерфейса WYSIWYG?
А.Да и нет. Пошаговый интерфейс администратора под названием «Руководства» отделен от стандартного интерфейса WYSIWYG. После создания руководств, содержащих шаги, шорткод можно разместить где угодно.
В. Я выполнил обновление, и теперь предварительный просмотр руководства не работает. Что мне делать?
A. В настоящее время предварительный просмотр руководств может 404 для руководств, созданных с использованием более ранних версий. Руководства, созданные после обновления плагина, должны быть в порядке.
Q. Когда я нажимаю кнопку просмотра, отображается страница с ошибкой 404.
А.Похоже, это ошибка WordPress, и мы нашли два обходных пути.
* Посетите страницу «Постоянная ссылка» и попробуйте снова просмотреть руководство.
* Измените руководство на «черновик» вместо «опубликовано» и используйте вместо этого функцию «предварительный просмотр».
Посетите полный раздел часто задаваемых вопросов по адресу kylembrown.com/step-by-step, чтобы получить дополнительную помощь и советы по устранению неполадок.
К сожалению, бесполезно. Изображения слишком маленькие. (Я использую тему Twenty Twenty.) Кроме того, вы не можете использовать изображения, уже загруженные в вашу медиатеку.
Я заказал версию Pro для размещения структур в моем интернет-магазине, а затем понял, что есть проблемы совместимости с шаблоном, который я использовал, поэтому я связался с компанией, чтобы узнать, могут ли они помочь с технической поддержкой. Они не только неустанно работали над исправлением этих проблем с совместимостью, но и в конечном итоге даже написали совершенно новую дочернюю тему шаблона, чтобы все работало! Это выходило за рамки обычного обслуживания, и, хотя для этого требовалась небольшая дополнительная плата, я очень благодарен Энди и команде за всю поддержку.
Моя собственная оценка как автора.
Было бы неплохо, если бы вы могли применить (лайтбокс) к ссылкам на изображения. слишком мал для просмотра. Тем не менее, хороший плагин.
Leggi Все отзывы о 13«Step by Step» — программа с открытым исходным кодом. Le persone che hanno contribuito allo sviluppo di questo plugin sono указывает di seguito.
Сотрудников0,4,5
- Протестировано на WordPress 5.4.1 (09.06.2020)
0,4,4
- Протестировано с WordPress 5.0.3 Gutenberg (17.01.2019)
0,4,3
- Протестировано с WordPress 4.9.6 (05.06.2018)
0,4,2
- Протестировано с WordPress 4.8.2 (27.10.2017)
0,4.1
- Протестировано с WordPress 4.8 (07.07.2017)
0,4,0
- Протестировано с WordPress 4.7 (08.12.2016)
0,3,9
- Протестировано на WordPress 4.6 (23.08.2016)
0,3,8
- Протестировано с WordPress 4.5.2 (08.05.2016)
0,3,7
- Протестировано с WordPress 4.5
0,3,6
- Протестировано с WordPress 4.4.2
0,3,5
- Ссылка на продукт перемещена в меню администратора
- Добавлена информация о боковой панели в настройках
0,3,3
- Протестировано с WordPress 4.4
0,3,2
- Протестировано на WordPress 4.3
- Обновленные теги
0,3,0
- Протестировано с WordPress 4.2
0,2,9
- Протестировано с WordPress 4.1
0,2,8
0,2,7
- Протестировано с WordPress 4.0
0,2,6
- Устранена проблема неработающей ссылки на изображение на нескольких сайтах
0,2,5
- Изменения для языковой поддержки
0,2,4
0,2,3
0,2.2
- Исправлена ошибка, препятствующая загрузке изображений в некоторых случаях.
- Незначительные исправления в названии.
0,2,0
- Исправлены направляющие, отображающие над всем основным текстом сообщения или страницы.
- Базовая категория изменена со статей на руководства во время предварительного просмотра
- Добавлено уведомление о предварительном просмотре направляющих.
- Добавлена возможность сохранять или удалять направляющие при переустановке / удалении плагина.
0,1,1
- Исправлены ошибки неопределенных индексов, обнаруженные при посещении страницы добавления новых руководств
- Исправлены ошибки при удалении направляющей
- Исправлены серые кнопки сохранения при попытке сохранить новое руководство.
- Исправлено отсутствие отображения шагов при нажатии кнопки предварительного просмотра
- Исправлены сообщения об ошибках смещения вверху страниц, на которые был вставлен шорткод.
- Добавлена ссылка на страницу плагинов для быстрого доступа к странице добавления новых руководств.
- Добавлена возможность предварительного просмотра гида перед публикацией.
0,1,0
Шаблон руководства пользователя и руководство по созданию собственного руководства за 15 шагов
Шаг 1 Общие сведения о шаблоне руководства пользователя
Прежде чем использовать шаблон руководства пользователя и другие инструменты, которые я разработал для Филиппа, я хотел убедиться, что у нас одна и та же отправная точка.Я предоставил ему некоторую общую информацию об инструкциях для пользователя и несколько хороших примеров существующих руководств пользователя.
Я перечислил эту информацию ниже.
Какое определение для руководства пользователя?
Руководство пользователя — это технический документ, предназначенный для помощи людям в использовании продукта. Хорошее руководство пользователя помогает пользователям безопасно, полезно и эффективно использовать продукт.
Другие названия или другие формы руководства пользователя могут быть:
- Руководство пользователя
- Техническая документация
- Инструкция по эксплуатации
- Руководство по эксплуатации
- Учебное пособие
- Краткое руководство
- Инструкция по установке
- Руководство по эксплуатации
- Руководство по программному обеспечению
Помимо основной цели руководства пользователя (помочь пользователю), второстепенными целями могут быть создание лучшего пользовательского опыта и выполнение требований законодательства.
Руководство пользователя состоит из текстовой визуальной информации (иллюстрации, снимки экрана, таблицы и т. Д.), Чтобы помочь пользователю в выполнении конкретных задач.
Пользователь играет центральную роль при составлении руководства пользователя. Хорошо составленное руководство пользователя предоставляет только ту информацию, которая актуальна для предполагаемого пользователя продукта.
Руководство пользователя должно содержать как процедурную информацию (пошаговые инструкции), так и концептуальную информацию (информацию, необходимую пользователю для понимания процедурной информации).
Хорошее руководство пользователя краткое и без жаргона. Хорошее руководство пользователя должно отвечать на вопросы КАК и ЧТО. Они должны содержать информацию о том, что произойдет, если задача не будет выполнена правильно.
В некоторых случаях продукт предназначен для использования разными типами пользователей. Типичными типами пользователей являются конечный пользователь, установщик, инженер по техническому обслуживанию и оператор. Каждому типу пользователя нужен свой подход с точки зрения используемого языка, тона голоса и предоставляемой концептуальной информации.
Какая информация должна быть в инструкции пользователя?
Для различных продуктов требуется руководство пользователя. Продукт может быть системой, инструментом, устройством, инструментом, частью программного обеспечения или приложением. В зависимости от типа продукта руководство пользователя может включать в себя следующие элементы:
- Название продукта
- Модель или типовой номер
- Использование по назначению
- Характеристики / аксессуары
- Описание основных элементов продукта
- Описание пользовательского интерфейса
- Предупреждения по безопасности
- Инструкция по установке
- Описание того, как использовать / работать с изделием
- Раздел «Поиск и устранение неисправностей» и инструкции по решению проблем
- Информация о техническом обслуживании
- Информация о ремонте
- Информация об утилизации продукта и упаковки
- Технические характеристики
- Содержание
- Индекс
- Глоссарий
- Информация о гарантии
- Контактная информация
Использование шаблона руководства пользователя
Основной инструмент, который я разработал, чтобы помочь Филиппу составить его руководство пользователя, — это шаблон руководства пользователя.Шаблон содержит всю информацию и многое другое из списка выше. Он соответствует требованиям, предъявляемым к его продукту.
Шаблон руководства пользователя можно использовать для создания руководства для вашей системы, инструмента, устройства, инструмента или для создания руководства по установке, руководства по программному обеспечению, руководства по эксплуатации, руководства по обслуживанию или учебного пособия.
На основе первого шаблона для Филиппа мы разработали шаблоны для следующих групп товаров:
Какие форматы есть в руководстве пользователя?
Руководства пользователя могут быть предоставлены в бумажном формате или в виде электронного документа (PDF или размещены в Интернете или на устройстве в формате HTML).Шаблон руководства пользователя представляет собой документ MS Word, который можно распечатать или разместить в Интернете.
Руководства пользователя можно создавать с помощью различных инструментов. У каждого инструмента есть свои достоинства и недостатки. Я упомяну наиболее распространенные инструменты ниже:
| Преимущества | Недостатки | |
| Слово | Легко освоить Шаблон руководства пользователя можно легко настроить | Менее подходит для больших документов Повторное использование содержимого невозможно |
| Indesign | Высокая степень свободы дизайна | Для изменения содержимого может потребоваться много дополнительных часов DTP |
| CMS (решения для технической разработки и публикации) | Повторное использование контента Все в одном решении Омни-платформенные публикации Содержит стандартные шаблоны руководств пользователя | Высокая кривая обучения |
Примеры из руководства пользователя
При составлении руководства пользователя с помощью шаблона руководства пользователя может быть полезно иметь несколько хороших примеров.По следующим ссылкам вы можете загрузить образец руководства пользователя для документации:
Шаг 2 Определите пользователей вашего шаблона руководства пользователя
Хорошо, теперь у Филиппа есть базовые знания о руководствах пользователя. Давайте углубимся в детали и действия.
Если вы хотите написать руководство, которое поможет вашему пользователю решать проблемы, вам сначала нужно определить, кто ваш пользователь. Это можно сделать, создав профиль пользователя, также называемый персоной.
С помощью персонажа вы делаете некоторые разумные предположения о характеристиках вашего пользователя.Это не только полезно для создания ваших инструкций для пользователя, но и является важным элементом в начале разработки любого продукта! Как образованный инженер по промышленному дизайну, мы начали все наши проектные задания.
При просмотре веб-сайта ISOVOX я даже не нашел четкого описания предполагаемых пользователей. Вот почему я попросил Филиппа определить своих пользователей и ответить на такие вопросы, как:
- Кто является пользователем вашего продукта?
- Используется ли продукт профессионально или преимущественно в частном порядке?
- Какой еще у них технический опыт? Что описывает пользователя?
Я создал шаблон, содержащий вопросы.Я попросил Филиппа заполнить шаблон.
Вы можете использовать шаблон самостоятельно, чтобы определить, кто ваш пользователь. Обратите внимание, что вторая вкладка также содержит ответы Филиппа, поэтому у вас есть пример того, как можно использовать лист.
Действие: Используйте шаблон, чтобы описать ваших пользователей.
Я ОГРОМНЫЙ фанат визуализации. Поэтому, если вы хотите сделать еще один шаг вперед по определению своего пользователя, я бы посоветовал вам визуализировать своего пользователя в форме персонажа. При создании персонажа вы даете своему пользователю имя, возраст и так далее, чтобы он стал реальным человеком, который представляет вашего пользователя.
Я сделал это для Филиппа. Это результат:
Действие: Создайте визуализацию вашего пользователя
Если вы хотите узнать больше об определении своей аудитории и создании персонажей:
https://www.nngroup.com/articles/persona/
http://www.astauthors.co.uk/aboutast/articles/determiningyouraudience.php
https://www.smashingmagazine.com/2014/08/ a-поближе-взглянуть-на-персонажей-часть-1/
https://www.prismnet.com/~hcexres/textbook/aud.html
Шаг 3 Создание тем для проблем ваших пользователей
Начните с определения проблем, с которыми ваши пользователи могут столкнуться в течение жизненного цикла продукта и которые они хотят решить.Типичные проблемы могут включать: установку продукта, использование продукта, безопасное использование продукта, обслуживание продукта и утилизацию продукта.
Если задача слишком сложная, ее можно разбить на части.
Я попросил Филиппа определить проблемы и решения, с которыми его пользователь может столкнуться в течение жизненного цикла продукта. Для этого я создал еще один шаблон для Филиппа. В левом столбце вкладки «Жизненный цикл» указаны этапы жизненного цикла продукта.Они основаны на международном стандарте инструкций пользователя IEC / IEEE 82079. Наши шаблоны руководств пользователя соответствуют этому стандарту.
На вкладке «Жизненный цикл» [ISOVOX] вы можете увидеть, как Филипп скорректировал жизненный цикл своего продукта.
Действие: Используйте этот шаблон и инструкции на первой вкладке, чтобы определить проблемы, которые могут возникнуть у вашего пользователя в течение жизненного цикла продукта, и представить их решения.
Если вы хотите узнать больше об определении проблем пользователей и создании тем:
Шаг 4 Определите структуру шаблона руководства пользователя
Филип определил проблемы, которые могут возникнуть у пользователя с его продуктом в течение его жизненного цикла, и подумал о решении этой проблемы.Другими словами: Филипп определил темы для своего руководства пользователя. Каждая тема может касаться только одного конкретного предмета, иметь определенную цель и должна быть самостоятельной.
Тема должна давать ответ только на один вопрос пользователя. Пользователь хочет решать одну проблему за раз. Когда пользователь решил проблему, он пойдет и решит следующую проблему.
Тема станет разделом в руководстве пользователя. Это может быть глава или (подпункт) параграф. Как только пользователь ищет ответ на свою проблему, он будет использовать оглавление, чтобы узнать, как перейти к этому ответу.
Я попросил Филиппа структурировать темы и определить их место в руководстве пользователя, назначив определенную тему определенной главе или (подпункту) параграфа. Результат можно увидеть на вкладке ToC [ISOVOX].
Действие: Чтобы определить структуру вашего руководства пользователя:
- Скопируйте содержимое со вкладки Lifecycle [название продукта] на вкладку ToC [название продукта] .
- На вкладке ToC [название продукта] замените название продукта своим собственным названием продукта.
- Добавьте столбец слева. Назовите его «Раздел».
- Если возможно, организуйте разделы логически.
- Определите, какие темы станут главами, добавив номера глав. Начните нумерацию ПРОДУКТА ПОДГОТОВКИ К ИСПОЛЬЗОВАНИЮ с номера 4. На следующем этапе мы добавим еще несколько глав.
- Определите, какие темы станут абзацами, добавив номера разделов.
- Определите, какие темы станут подпунктами, добавив номера подразделов.
Вы создали оглавление (ToC). ToC — это схема вашего руководства пользователя. Позже мы добавим еще несколько тем / разделов, таких как Введение, Информация о безопасности и т. Д., Так что не беспокойтесь о добавлении этого сейчас.
Шаг 5 Создание значимых заголовков
Каждый раздел в руководстве пользователя имеет свой заголовок. Заголовки — это (под) заголовки, которые предшествуют фактическому тексту. Они появляются в ToC, поэтому пользователь может перейти к необходимой информации.
Итак, Филипп только что создал (под) заголовки для своих тем.
Поскольку записи ToC играют такую важную роль, помогая вашему пользователю сориентироваться, и чтобы помочь ему пропустить то, что НЕ важно, им нужно немного больше внимания.
В принципе, вы должны попробовать работать с тремя уровнями заголовков: заголовками первого, второго и третьего уровня.
Заголовок первого уровня описывает, чему посвящена вся глава или раздел (например, УСТАНОВКА ПРОДУКТА).Заголовки второго уровня должны использовать формулировку «как что» (например, «Как собрать изделие» и «Как выполнить электрический монтаж», ). В заголовке третьего уровня используются словосочетания-существительные (например, Содержимое упаковки и Используемые инструменты ).
Я попросил Филиппа перенаправить свои заголовки и обратить внимание на следующие общие правила:
- Используйте структуру, показанную выше, для заголовка первого, второго и третьего уровня.
- Убедитесь, что заголовки не требуют пояснений. Заголовок Приготовление блинов гораздо больше ориентирован на пользователя, чем с использованием MagicCook5000 .
- Убедитесь, что заголовок охватывает всю тему. Если раздел охватывает техническое обслуживание и ремонт продукта, заголовок Техническое обслуживание будет неполным.
- По возможности старайтесь опускать статьи в начале заголовков .
Действие: Напишите новые заголовки для записей ToC.
ToCPhilips с содержательными заголовками можно найти в ToC w. Вкладка «Значимые заголовки» .
Шаг 6 Определите юридическое содержание
В зависимости от рынка, на котором ваш продукт размещается или вводится в эксплуатацию, а также в зависимости от группы продуктов, к которой он принадлежит, к вашему продукту применяются определенные законы.
В целом, законодательство требует, чтобы ваш продукт был «безопасным», и поэтому содержит общие требования безопасности, которым он должен соответствовать.
Эти требования также включают требования к содержанию вашего руководства пользователя и инструкции по технике безопасности.
Чтобы продавать свой продукт на определенном рынке, вы должны убедиться, что ваше руководство пользователя соответствует этим требованиям.
Эти две статьи ниже расскажут вам, как точно узнать, какое законодательство применяется к вашему продукту для рынка Европы и США и каковы требования к вашему руководству пользователя. Совет от профессионала: когда уже имеется Декларация соответствия, вы можете найти в ней соответствующие директивы.
Филиппу не нужно было выполнять эти шаги, поскольку шаблон, который он использовал, уже содержал юридическое содержание, как того требуют соответствующие директивы.
Для его продукта это означает, что для руководства пользователя для его продукта требуется следующая информация:
ЕС (соответствующие директивы по маркировке CE: LVD, EMC, RoHS, WEEE, REACH):
- Руководство пользователя должно быть переведено на язык (языки) страны, в которой продается продукт.
- Руководство пользователя должно описывать предполагаемое использование продукта.
- Руководство пользователя должно описывать разумно предвиденное непреднамеренное использование продукта.
- Если применимо, следует указать несоответствие в жилых районах.
- Тип, партия, серийный номер или другой элемент, позволяющий идентифицировать продукт, должны быть указаны на продукте. Если изделие слишком маленькое, это можно указать в руководстве пользователя.
- Название, зарегистрированное торговое название или зарегистрированный товарный знак и почтовый адрес должны быть указаны на продукте.Если изделие слишком маленькое, это можно указать в руководстве пользователя.
- Для определения остаточных рисков, связанных с использованием продукта, необходимо провести анализ рисков. Информация по безопасности должна быть предоставлена для информирования пользователя о мерах, которые необходимо принять.
- Информация WEEE должна быть включена
- Должна быть указана информация об отходах упаковки.
Помимо этого законодательства, существует также международный стандарт для руководств пользователя IEC / IEEE 82079-1: 2019.Этот стандарт гармонизирован в ЕС. Соблюдение гармонизированных стандартов обеспечивает презумпцию соответствия соответствующему законодательству!
Шаблон руководства пользователя соответствует этому стандарту.
Я также создал контрольный список IEC 82079, который можно использовать для двойной проверки соответствия вашего руководства этому стандарту.
Чтобы создать руководство пользователя, соответствующее международным стандартам, вы всегда должны убедиться, что ваше руководство соответствует требованиям ЕС, США и требованиям 80279.
Действие: Чтобы определить юридические требования к вашему руководству пользователя:
- Выполните шаги 1-2 из норм ЕС и / или шаги 1-6 из статей о соответствии требованиям США, чтобы определить правовую основу для ваших инструкций.
- Изучите контрольный список IEC 82079, чтобы убедиться, что ваше руководство соответствует стандарту 82079.
В этом видео я объясняю, как создать руководство, соответствующее стандарту 82079:
В МАГАЗИН
Шаг 7 Загрузите и подготовьте шаблон руководства пользователя
Теперь Филипп может приступить к созданию своего руководства пользователя.
Я попросил его скорректировать оглавление шаблона в соответствии с его собственным оглавлением. Без снятия и обязательных элементов конечно …
Вы помните из шага 4, что я просил начать нумерацию разделов с главы 4? Как только вы сами загрузите документ с шаблоном руководства пользователя, вы увидите, что были добавлены несколько стандартных глав, а также некоторые приложения.
Действие: Для корректировки шаблона руководства пользователя:
Если вы хотите работать с бесплатным шаблоном:
- Загрузите бесплатный шаблон руководства пользователя Word 2013 или 2007
- Измените заголовки разделов в соответствии с вашими собственными Условиями использования. Уведомление! Не изменяйте содержание. Оглавление может обновляться автоматически после настройки заголовков разделов.
- Добавьте обязательное содержимое, как определено в шаге 6 вашего руководства.
- Если возможно, измените разделы 1-3 и приложения в соответствии со своими потребностями.
Или воспользуйтесь одним из наших платных шаблонов, которые содержат весь обязательный контент, как это сделал Филип:
Шаг 8 Создайте контент для шаблона руководства пользователя
Запишите предполагаемое использование
Назначение вашего продукта, или, лучше сказать: предполагаемое использование, составляет основу руководства пользователя и составляет основу для обеспечения безопасного и здорового использования продукта.
Способ описания предполагаемого использования также определяет вашу ответственность и влияет на дальнейшее содержание руководства пользователя.
Большинство законов требует, чтобы вы включали описание предполагаемого использования в инструкции для пользователя.
Международный стандарт инструкций для пользователя IEC 82079-1 дает следующее определение предполагаемого использования:
Исчерпывающий набор функций или предполагаемых приложений, определенных и разработанных поставщиком продукта
Описывая предполагаемое использование, вы определяете безопасную оболочку продукта.И после того, как вы определили предполагаемое использование, вы можете сосредоточиться на предоставлении только тех инструкций по безопасности и пользователю, как использовать продукт в данном пакете.
Кроме того, что касается предполагаемого использования, многие другие стандарты, директивы и правила также требуют, чтобы вы включили описание разумно предсказуемого неправильного использования.
Например, разумно предсказуемым неправильным использованием агрессивного моющего средства может быть его использование в среде пищевой промышленности.
Слишком мало внимания к описанию разумно предсказуемого неправомерного использования повлияет на ответственность компании.
Законы / нормативные акты об ответственности за качество продукции возлагают на производителя ответственность за дефектный продукт. Если необходимо определить дефектность товара, будут учтены все обстоятельства. Это включает в себя разумно предсказуемое использование продукта.
Описание предполагаемого использования определяет, какие инструкции приведены в остальной части руководства. Например, если система охлаждения используется только для охлаждения определенных лекарств, то необходимо описать только эти процедуры.
Если можно разумно предвидеть, что система охлаждения может использоваться как система для охлаждения органов, это должно быть описано в инструкции. Тем самым вы, как производитель, ограничите свою ответственность и сможете сосредоточиться только на описании того, как использовать систему для охлаждения лекарств.
Действие: укажите предполагаемое и разумно предсказуемое неправильное использование вашего продукта.
Рис. 1. Разумно предсказуемое неправильное использование?
Напишите предупреждения по технике безопасности на основе анализа рисков
Даже несмотря на то, что предполагаемое использование теперь четко определено, это не означает, что использование продукта полностью без риска.
Чтобы определить опасности, связанные с использованием продукта, вы можете провести анализ рисков. Анализ рисков также может быть обязательным для определенных групп продуктов, таких как низковольтное оборудование, игрушки, машины и оборудование для использования во взрывоопасных средах.
Стандарты, такие как ISO 12100, были разработаны о том, как проводить анализ рисков. ISO 12100 также дает метод принятия мер по смягчению последствий: трехэтапный метод. Согласно этому методу существует следующая иерархия мероприятий по снижению риска:
- Конструктивные меры по обеспечению безопасности
- Защитные и дополнительные меры защиты
- Информация по применению
Это означает, что руководство пользователя должно предупреждать о любых остаточных рисках, связанных с использованием продукта.Это сделано с предупреждениями о безопасности.
КУПИТЬ
Хорошее предупреждение о безопасности описывает характер опасной ситуации, последствия отказа от опасной ситуации и методы ее предотвращения.
Для обозначения степени опасности, с которой может столкнуться пользователь, следует использовать сигнальные слова «Опасность», «Предупреждение» и «Осторожно».
Обратите внимание на следующие сообщения по технике безопасности:
ВНИМАНИЕ! Вращающиеся детали.Риск получения серьезных травм. Держите руки подальше. Блокировка / маркировка перед обслуживанием.
Затем вы хотите предупредить пользователя о возможной опасной ситуации. Стандарт ANSI Z535.6 описывает следующие места в руководстве пользователя, где это может быть:
- Сгруппированы в отдельную главу.
- В первой части специального раздела:
Пошаговая инструкция — Ubertesters
Создать новую организацию
Организация — это совокупность проектов на разных платформах, объединенных общей бизнес-целью.
Перейдите на https://dashboard.ubertesters.com/home и нажмите «Создать новую организацию» кнопку.
Заполните форму и нажмите «Создать новую организацию» кнопку.
Создать новый проект
2.1. Добавить проект
Перейдите на https://dashboard.ubertesters.com/home и нажмите «Создать новый проект» кнопку.
Выберите вашу организацию, платформу — Android или iOS, введите название проекта и нажмите «Создать проект» . Вы также можете перетащить туда файл .ipa или .apk , чтобы загрузить первую ревизию.
2.2. Интегрируйте Ubertesters SDK в свой проект
Чтобы начать использовать платформу Ubertesters, вам необходимо интегрировать наш SDK с кодом вашего мобильного проекта. Существует простой процесс интеграции SDK, позволяющий использовать нашу полную библиотеку Ubertesters.
Чтобы загрузить архив SDK, посетите https://ubertesters.com/download-sdk/. Вы можете найти инструкции по интеграции для платформ iOS и Android, нашего API и различных кросс-платформенных платформ, таких как Unity, PhoneGap / Cordova, Xamarin и других. Перейдите на страницу настроек проекта и скопируйте идентификатор проекта для использования при интеграции с вашими сборками.
2.3. Загрузите ревизию сборки в проект
Требуется загрузить сборку (ревизию) вашего приложения, чтобы начать процесс тестирования.
- Перейдите в меню «Проекты» вверху страницы, чтобы просмотреть список проектов
- Нажмите «Загрузить ревизию» кнопку (1) . Если вы загружаете первую версию в проект, вы увидите синюю кнопку «Загрузить первую версию» (2) .
- Перетащите файл .ipa или .apk в область, выделенную пунктирной линией, чтобы загрузить его.
- После завершения обработки файла введите название и описание редакции и нажмите «Подтвердить редакцию» . Вы также можете перетащить файл .apk (для извлечения ресурсов проекта)
Добавить устройства в личный кабинет
Сборки необходимо протестировать на мобильных устройствах.Вам необходимо добавить свои устройства или устройства ваших тестировщиков в учетную запись для работы с ними.
Перейдите на https://dashboard.ubertesters.com/ и нажмите «Подключите устройства» .
Здесь вы увидите список устройств, добавленных в ваш аккаунт, и сможете добавить новое.
Щелкните «Подключить устройство» . Вам будет предложено добавить устройство одним из следующих вариантов:
Для подтверждения выполните следующие действия:
- iOS : нажмите «Установить Ubertesters для iOS» .Запускаем приложение и авторизуемся.
- Android : нажмите «Установить Ubertesters для Android» . Запускаем приложение и авторизуемся.
Подключите аккаунт к социальным сетям
Это необязательный шаг, но он сэкономит вам много времени. Когда учетная запись связана с одной из социальных сетей, вы сможете войти в Ubertesters, используя ее.
Нажмите «Подключить социальные сети»
Выберите социальную сеть из предложенного списка и нажмите «Подключиться» . Примите условия использования выбранной службы для подключения учетных записей.
Пригласить участников
Чтобы начать работу над проектом, нужно пригласить свою команду. Количество участников, которых можно добавить, зависит от вашего плана.
Перейдите в «Проекты» и щелкните свой проект. Перейдите на вкладку «Администрирование» и нажмите «Добавить участников»
Требуется добавить следующие реквизиты:
- адрес электронной почты нового участника — вы можете ввести адрес электронной почты вручную или импортировать контакт из файла CSV.
- введите сообщение новому участнику, которое будет ему отправлено, или оставьте его пустым.
- предоставляет роль новому участнику — это может быть QA, Разработчик или Менеджер. У каждой роли разные права.
- выберите группу рассылки (необязательно) — это может быть одна группа или несколько.
Начать тестирование новой ревизии
Когда новая ревизия загружена, необходимо запустить ее, чтобы она стала доступной для тестировщиков.
- Перейдите в меню «Проекты» и выберите проект .
- Перейти на вкладку «Редакции (3-я)» в левом меню навигации
- Нажмите «Пуск» на версии, с которой вы хотите работать.
- Отметьте участников, которых вы хотите включить в проект, и нажмите «Начать тестирование ревизии». Установите флажок «Отправить уведомление», если вы хотите уведомлять пользователей по электронной почте.
Запустить проект / приложение на устройстве и запустить процесс тестирования
Вы увидите свой проект / приложение в мобильном приложении Ubertesters, загрузите желаемую сборку / версию, и вы увидите новый значок на устройстве с названием вашего проекта.
