Команда, разрабатывающая софт для создания пользовательской документации, делится лайфхаками на тему написания идеальной пользовательской документации для тех, кто далёк от написания руководств к программе.
Для чего мы сами конструируем некоммерческие образцы документации и инструкций для пользователей
Наш проект существует и развивается уже долгое время, практически шестнадцать лет, если быть точнее. За этот срок была сформирована определенная база, где собраны самые актуальные и насущные вопросы, которые возникают перед людьми, создающими справочные элементы к своему проекту.
Ведя диалог с нашими клиентами, мы смогли выделить их потребности и понять основную «боль». Если обобщить, основная проблема заключалась в том, что ни одна программа для создания файл-справок и инструкций не могла выполнить самую нудную, энергозатратную часть проекта — само разрабатывание и оформление этой пользовательской документации
Даже имея осознание того, что файл-справка — неотъемлемый и действительно полезный элемент для пользователя, очень редко возникает мотивация оформить его грамотно и качественно. Еще реже желание возникает, когда в написании пользовательской документации нет опыта или специалистов, которые бы этот опыт имели. Обычно, эта обязанность с легкой руки падает на плечи самих создателей программы, людей, занимающихся тестированием, аналитикой, специалистам поддержки или даже руководителей компании, которые тоже не совсем понимают, как грамотно создать что-то подобное.
Видео инструкция по работе с программой!
Отсюда вытекает еще одна загвоздка. Люди, у которых нет опыта и в принципе понимания, как начать и что туда вносить, просто не знают, как создать качественное руководство для пользователей. В таких случаях большинство следует привычному пути: загуглить определение и найти готовый шаблон.
И с какой-то стороны, это разумно. Мы достаточно часто сталкиваемся с такими запросами, пользователи просят у нас пошаговое руководство или хотя бы костяк готовой инструкции.
Так вышло, что потребности наших клиентов практически на сто процентов входят в нашу экспертную сферу. И мы приняли решение по возможности помочь всем, кто хочет (или вынужден) заниматься созданием файл-справок и инструкций к своему продукту и предоставить возможность получить образцы, которые могут послужить базой и легко быть адаптированными под конкретный запрос.
В связи с этим, мы сами создали готовые образцы и костяки шаблонных проектов в программе. Что входит в нашу базу:
- Руководство пользователя программного обеспечения.
- Руководство пользователя web-сервиса.
- Корпоративная база знаний компании.
В чем удобство создания руководства пользователя по образцу
Вы бережете своё время.
Адаптируя уже созданный образец под свой продукт, вы не тратите время на создание основы с нуля, вам не нужно тратить время, чтобы найти мастер-класс о том, как правильно это сделать. Используя готовый шаблон документации, вы значительно экономите время на создание структуры проекта с нуля и на поиск и изучение информации о том, как это делается.
Вы сосредотачиваете внимание на вашей программе, а не на создании файл-справки
В шаблоне уже есть текстовые и графические вставки, вы можете сами добавлять нужный контент в предложенные места и не продумывать вариант оформления.
Наглядность.
Все образцы и костяки инструкций для пользователя изначально настроенные с динамическими стилями оформления, которые помогут вам быстрее освоиться и разобраться, как можно использовать это для быстрого выполнения своей цели.
Адаптация шаблонов и образцов под ваш проект.
Всё, что находится в шаблонах, можно назвать нашим советом, который был создан на основе многолетнего опыта в данной сфере и выработанной экспертностью. Абсолютно всё в этих шаблонах может быть подвержено адаптации, так как для пользовательской документации нет жестких стандартов, она должна быть выстроена персонально под ваш продукт.
О шаблонах
За 15 лет мы смогли подвергнуть аналитике более сотни разных файл-справок, инструкций и технических документаций, что дало нам возможность сделать вывод и определить шаблонные разделы, которые могут быть применены к огромному количеству программ, после чего мы интегрировали их в наши образцы. Давайте немного подробнее поговорим о структуре.
Пользовательский интерфейс. Здесь вы можете наглядно показать вашему клиенту интерфейс, ознакомить его со всеми режимами, дополнительными кнопками и.т.д. Если пользователь может персонализировать интерфейс под себя, об этом тоже лучше указать именно в этом разделе.
Типовые задачи. Здесь нужно максимально подробно познакомить пользователя со всеми основными возможностями программы и детально описать ряд задач и вопросов, которые клиент сможет решить с её помощью. В нашем образце этот блок сформирован из двух подразделов.
В подразделе «Примеры использования» лучше всего рассказать пользователю, как ваш продукт будет решать его вопросы и задачи. Если обобщить, то в этом подразделе вы рассказываете про клишированные проблемы, с которыми сталкивается большинство пользователей. В подразделе «Лучшие практики» лучше разместить максимально полезную информацию о том, как упростить свою работу в программе и как пользоваться ей максимально эффективно.
Особые случаи. Здесь нужно рассказать пользователю про то, какие трудности могут возникнуть и как их решить, выделить часто задаваемые вопросы и дать на них самый доступный ответ. Подразделы: «FAQ» и «Устранение типовых проблем»
Вспомогательная и юридическая информация. Здесь вы размещаете информацию о компании, размещаете контактные данные тех.поддержки, информацию о сотрудничестве, сайт, а также лицензионные соглашения.
Названия проекта публиковать не будем, Хабр ругается.
P.S. Мы будем рады, если наши образцы помогут вам закрыть вопрос и успешно реализовать документацию в своем проекте.
Источник: habr.com
Как написать руководство пользователя: подробная инструкция
Руководство пишется для того, чтобы помочь людям использовать технику, мебель, транспорт и т. д. Пишется максимально простым и доступным языком, чтобы было понятно человеку с любым уровнем интеллекта. Как хорошо писать классическое руководство я поэтапно расскажу в статье.
Содержание статьи скрыть
Топовую подборку профессиональных курсов от ведущих школ: обучение копирайтингу с нуля
Исследуйте тему
Чтобы автору написать понятное руководство ему нужно самому хорошо разбираться в теме. Неважно — являетесь вы экспертом в области или нет, нужно обязательно прочитать информацию из разных источников. Или ещё раз освежить материал в памяти.
Чтобы инструкция получилась полезной копирайтеру нужно разбираться в отрасли на 100%, но описывать её с позиции новичка. То есть ставить себя на место читателя. Прочитайте аналогичные статьи на похожие товары. Это поможет вам лучше разобраться в структуре и стиле такого контента.
Ежедневные советы от диджитал-наставника Checkroi прямо в твоем телеграме!
Подписывайся на канал
Подписаться
Разработайте план и напишите текст
После тщательного изучения материала можно приступать к планированию. Продумайте, с чего лучше начать и чем продолжить. На примере инструкции к пылесосу «Xiaomi mi robot vacuum cleaner» я расскажу о принципах написания такого текста.
Опишите сначала азы (описание программы, техники), затем усложняйте текст (как исправить ошибки при работе с продуктом).
Не пишите специальные термины, понятные только узкому кругу читателей. Текст должен быть понятен любому. Если без этого никак — распишите каждый термин понятным языком.
Не используйте в работе личное мнение или собственный опыт пользования товаром. Инструкция — это документ, в котором структурно и чётко описаны шаги и действия.
Добавляйте в статью скриншоты. Наглядно понять работу программы или техники намного проще.
Пишите даже те моменты, которые кажутся очевидными и понятными без описания. Они понятны вам. Но не факт что и всем остальным тоже.
Пишите текст короткими предложениями с глаголами повелительного наклонения: «Включите компьютер», «Нажмите на кнопку…», «Включите в розетку…».
Придерживайтесь логики и будьте последовательны. Например, при описании программного обеспечения для ПК: «Включите компьютер. Вставьте диск в дисковод…». Будет нелогично писать: «Начните работу с диском, затем включите ПК». Завершайте инструкцию ответами на частые вопросы и/или описанием неисправностей и как их устранить.
После того как статья будет готова — дайте её прочитать другу или знакомому, и спросите, насколько она понятна. Так вы сможете исправить недочёты и испытать ваш текст в действии.
Источник: checkroi.ru
Инструкция по 1С: Управление Торговлей
Для кого же может быть полезен и удобен данный программный продукт? В первую очередь для организаций, занимающихся оптовой и розничной торговлей, дистрибьюцией, выступающих в торговых операциях в качестве посредников, которые хотят полностью автоматизировать и контролировать свою торговую деятельность, управлять своими складами, контролировать запасы, осуществлять управление продажами, закупками и финансами.
Сразу следует отметить, что если ваша организация занимается розничной торговлей и реализует товары конечному потребителю, то имеет смысл ознакомиться и с программой 1С Розница. Возможно, ее функционала будет достаточно для учета торговой деятельности. В рамках данной статьи ее возможности мы рассматривать не будем.
Из общих особенностей программы 1С Управление Торговлей: позволяет осуществлять ведение учета по торговому предприятию в целом, если в его состав входит несколько организаций, поддерживает такие системы налогообложения как ОСНО, УСН. Также возможно ведения учета для ИП. Программа поддерживает обмен с ЕГАИС, ГИСМ, Меркурий, ИС МП. Имеется возможность обмена с другими имеющимися программами 1С, к примеру Бухгалтерией, а также возможность обмена с сайтом (интернет-магазином). Имеется возможность обмена по ЭДО с банками и контрагентами.
Чтобы было проще ориентироваться в возможностях программы, разобьем ее функционал на 7 блоков. Если для ведения учета не требуется использовать весь функционал программы, то гибкая настройка при помощи включения или выключения функций, позволит вам оставить только то, что необходимо для ведения учета.
1) Блок “Управление продажами”. Данный блок включает в себя помощника продаж, представляющего собой рабочее место менеджера. Возможность управления доставкой, корректировку реализаций товара, заявки на возврат. Также сюда можно отнести имеющийся в программе CRM, который позволяет вести учет заказов клиентов, учитывать условия продаж, причины неудовлетворенности, причины отмены заказов, оценивать эффективность работы с клиентами и пр. Имеется возможность подключения торгового оборудования и продажи в розницу через автоматизированное рабочее место кассира (АРМ Кассира), возможность проверки надежности контрагентов.
2) Блок “Управление закупками”. Позволяет вести учет поставщиков, учет заказов поставщикам, вести учет номенклатурных позиций поставщиков, учет соглашений с поставщиками, осуществлять корректировки поступлений, вести учет заказов на внутренне потребление, заказов на перемещение, сборку и разборку товарных позиций, вести учет возвратов и перемещений товаров, оформлять таможенные декларации и пр.
3) Блок “Управление Маркетингом”. Возможность учитывать цены номенклатурных позиций и услуг, вести учет соглашений с конкурентами, учитывать условия предоставления скидов, вести учет графиков оплаты, карт лояльности, а также вести учет различных маркетинговых мероприятий.
4) Блок “Складского учета”. Позволяет вести учет товаров на складке, позволяет осуществлять пересчет товара, учитывать порчи, излишки недостачи.
5) Блок “Финансового учета”. Поддержка эквайринговых операций, возможность составлять платежный календарь, проводить наличные и безналичные платежи, работа в подотчетниками и пр.
6) Блок “Управление документам”. Возможность формировать различные документы, связанные с поступлений товара, реализацией, складские документы и др.
7) Блок “Нормативно-справочной информации (НСИ)”. Включает в себя справочники партнеров и клиентов, структуру предприятия, проекты, номенклатуру, склады, кассы, графики работы и пр.
Для каждого из пяти первых блоков имеется возможность формировать аналитические отчеты, с возможностью их настройки для каждого пользователя программы.
Резюмируя вышеперечисленные блоки, можно сказать, что 1С Управление Торговлей достаточно сложный программный продукт и придется потратить некоторое время на его изучение, чтобы понимать принцип работы. Но старания будут оправданы.
Теперь давайте перейдем к самой программе, посмотрим ее интерфейс и некоторые моменты для большего понимания ее работы. Главное окно программы представляет собой список задач и текущих дел. Слева отображаются вышеперечисленные разделы (блоки) программы. Список разделов может быть различным для разных пользователей – это настраивается при помощи системы прав.
В разделе “НСИ и администрирование” в подгруппе “Настойки НСИ разделов” можно управлять включением и выключением различными возможностями программы. К примеру, окно управления настроек номенклатуры будет иметь следующим вид
При создании партнера (контрагента) в программе можно указать кем он будет являться по отношению к нашей организации: поставщиком, клиентом, конкурентом или прочие отношения. Указать ответственного менеджера, всю необходимую контактную информацию.
Раздел программы “Главное” является неким разделом для оперативной работы, где представлены общие функции
Если нам необходимо оформить какую-либо операцию, связанную с продажами, к примеру, заказ клиента, то как правило она будет находиться в соответствующем разделе. В данном примере в разделе “Продажи”.
Аналогично и с другими объектами программы. Все они расположены как правило на своих местах. Также у каждого объекта в программе можно открыть подсказку и посмотреть, для чего используется тот или иной документ, отчет или справочник. Сделать это можно по кнопке со значком “знак вопроса” или по кнопке “F1”, находясь в этом объекте.
После этого будет открыта справка о данном объекте.
Подводя итог, хочется отметить, прежде чем начинать работать в программе, необходимо хорошо ее изучить. Сделать это можно самостоятельно, изучив инструкцию по работе с программой, либо прочитав информацию на сайте ИТС. Второй вариант – пройти курсы по 1С УТ, где с преподавателем на конкретных практических примерах разобрать все возможности программы от первоначальной настройки до формирования итоговых отчетов руководству по отраженным документам в системе.
Рекомендуем прочитать еще эти статьи
1С.ERP. Управление предприятием 2— это продукт используют, например те производственные предприятия, которые поэтапно заказывают товар. У.
Главные отличительные особенности конфигураций «1С Документооборота 8»
При заключении договора 1С: ИТС вам становятся доступны различные возможности системы. Их количество зависит о того, что вы выбрали, а именно.
Источник: trend1c.com