Повчальні характеристики, структура та приклади

A повчальний Це документ, який намагається дати деяку інформацію про те, як зробити щось зокрема. Ці тексти служать керівництвом для індивіда, щоб знати правильний спосіб виконання дії або інформувати про щось.

Більшість інструкцій мають письмове керівництво або текст з інструкціями, а також деякі пов'язані з ними зображення (наприклад, діаграми), які можуть допомогти людині зрозуміти проблему..

Ідея полягає в тому, що інструкції написані нетехнічним способом, щоб їх можна було зрозуміти найбільшою кількістю людей.

Рівень технічної термінології та рівень змісту повинні відрізнятися від керівництва для експертів, оскільки інструкції повинні бути спрямовані на звичайного громадянина..

З цієї причини важливо визначити, до кого спрямований посібник; різні читачі будуть мати різні вимоги.

Крім того, інструкції повинні мати структуру, що включає обкладинку, вступ, глосарій, загальний опис і інструкції, серед інших елементів.

Як випливає з назви, в інструкції написані тексти, які допомагають людям зрозуміти, як користуватися системою.

Взагалі, інструкції необхідні при реалізації технологічної системи Росії програмного забезпечення, зібрати предмет меблів або інструкції щодо використання електронного пристрою.

Інструкції повинні бути першим елементом, який необхідно прочитати при придбанні нового продукту.

Читаючи інструкції, ви можете вирішити багато сумнівів, не вимагаючи технічної підтримки або підтримки від виробника.

Основні характеристики інструкції

- Включені покрокові інструкції щодо використання продукту.

- Вони містять абсолютно всі інструкції продукту, у всіх можливих аспектах.

- Вони починаються з швидкого посібника користувача на одну сторінку.

- Вони повідомляють користувачеві, якими є функції продукту і для чого вони призначені, а не тільки як використовувати ці функції.

- Вони враховують потреби користувачів з обмеженими можливостями (наприклад, слабкий зір або кольорова сліпота) та надають альтернативні інструкції для цих користувачів, такі як аудіо, шрифт Брайля або великі літери.

- Вони використовують тільки одну мову.

- Вони мають ефективне використання кольору.

- Ваші сторінки пронумеровані та мають індекс.

- У них є фотографії або схеми, які допомагають зрозуміти продукт і інструкції.

- Вони використовують чистий і читаний джерело; це означає, що вони не використовують шрифти з засечками.

Структура

1 - Вступ

Він містить всю найважливішу інформацію для користувача для використання всієї системи або продукту. Ця частина повинна включати опис функцій системи та її можливостей, непередбачених обставин та альтернативних режимів роботи, покрокових процедур та використання.

Якщо можливо, слід використовувати графіку. Цей розділ також дає опис мети інструкції, її організацію та можливі посилання.

2- Контактні точки

Цей розділ визначає коди організації та команди, які можуть допомогти користувачеві. Якщо є будь-яка телефонна або довідкова служба, вона описана в цьому розділі.

3- Основні бізнес-функції

Цей розділ включає бізнес-перспективу основних обов'язків користувача щодо продукту або системи.

4 Глосарій

Ось глосарій термінів і скорочень, які використовуються в інструкціях. Якщо він дуже довгий, більше декількох сторінок, він поміщається як додаток.

5- Можливості системи або продукту

У цій частині наведено короткий опис системи та можливостей продукту; його мета повинна бути описана.

Ідея полягає в тому, щоб користувач розумів функції та операції системи, включаючи конкретні функції високого рівня. Графи або таблиці повинні бути включені, якщо це необхідно.

6- Опис функцій

Описано кожну конкретну функцію системи. Можна включити наступне:

- Призначення та використання функції. Потрібно також додати зв'язки з іншими функціями.

- Ініціалізація функції, якщо це можливо.

- Параметри виконання, пов'язані з функцією і їх описом.

- Опис очікуваних внесків та їх результатів.

7- Підготовка вхідних функцій

Цей розділ містить вхідні дані, необхідні для належної роботи системи або продукту.

8- Результати

Очікувані результати кожної функції також повинні бути включені. Ці результати повинні включати графіку, текст і таблиці, які можуть допомогти користувачеві. Крім того, також розміщені приклади.

9 - Інструкції з експлуатації

Ось список процесів, пов'язаних з інструкцією з експлуатації. Наприклад, вона повинна містити процедури для входу в систему, якщо вона застосовується.

Ця процедура ініціалізації повинна описувати, як встановити необхідний режим роботи і як ініціювати параметри, необхідні для роботи.

10- Технічне обслуговування

Цей розділ містить процедури, що дозволяють працювати належним чином у системі або у пристрої.

11 - Помилки

Цей розділ повинен містити будь-яке повідомлення про помилку, яке може з'явитися в системі, або будь-яку можливу несправність обладнання.

Наприклад, ви повинні включити список всіх повідомлень про помилки, які можуть з'явитися, що вони означають і як їх вирішити.

Приклади інструкцій

1 - Інструкції зі складання крісла

Безпека

Прочитайте, зрозумійте і дотримуйтесь інструкцій з безпеки для кожного з них. Якщо ви не розумієте, зверніться до виробника.

Захищайте свої очі захисними окулярами, вухами з ізоляторами та легенями респіратором або маскою.

План будівництва

Вирізати дерев'яну дошку 2x4x8, чотири столи 1x3x1 і три столи 5x3x2.

Зібрати таблицю за схемою і позначити олівцем точки поєднання в кутах. Потім закріпіть деталі цвяхом і молотком.

2. Інструкції Mplus

Mplus - це програма статистичного моделювання, яка дає дослідникам гнучкий інструмент для аналізу їх інформації.

Він пропонує користувачам різні моделі, оцінки та алгоритми в зручному для користувача інтерфейсі.

Організація

Глава 2 описує, як почати використовувати Mplus. З глави 3 до 13 вони містять приклади аналізу, які можна зробити з програмою. У главі 14 розглядаються особливі проблеми.

Глава 1

На малюнку на наступній сторінці показано різні відносини, які можна моделювати в Mplus.

Прямокутники являють собою спостережувані змінні; змінні у фоновому режимі відображаються як x.

Кола представляють латентні змінні, а стрілки на малюнках представляють взаємозв'язки між змінними.

Особливості:

1 - Індивідуальний або груповий аналіз.

2- Стратифікація, ймовірності відбору, реплікації ваг і поправок кінцевої популяції.

3- Максимальна оцінка видів результатів.

Diagrammer

Його можна використовувати для малювання вхідної діаграми. Щоб увійти до цієї функції, потрібно відкрити меню компонування в редакторі Mplus. Для складання діаграми використовується набір інструментів для малювання.

Калькулятор LTA

Розраховуються умовні ймовірності, включаючи приховані ймовірності переходу для різних значень. Його можна використовувати при виборі калькулятора LTA з меню Mplus редактора Mplus.

Список літератури

1. Посібник з експлуатації. Отримано з statmodel.com
2. Новики керівництва по будівництву меблів (2017). Отримано з sawsonskates.com
3. Поради щодо написання посібників користувача. Отримано з userfocus.co.uk
4. Посібник користувача. Отримано з wikipedia.org
5. Посібник користувача. Відновлено з klariti.com