ИНСТРУКЦИЯ ПО ПРИМЕНЕНИЮ ПЛАНА СЧЕТОВ БУХГАЛТЕРСКОГО УЧЕТА ФИНАНСОВО-ХОЗЯЙСТВЕННОЙ ДЕЯТЕЛЬНОСТИ ОРГАНИЗАЦИЙ \ КонсультантПлюс
Утверждена
Приказом Министерства финансов
Российской Федерации
от 31 октября 2000 г. N 94н
Список изменяющих документов
(в ред. Приказов Минфина РФ от 07.05.2003 N 38н,
от 18.09.2006 N 115н, от 08.11.2010 N 142н)
Настоящая Инструкция устанавливает единые подходы к применению Плана счетов бухгалтерского учета финансово-хозяйственной деятельности организаций и отражению фактов хозяйственной деятельности на счетах бухгалтерского учета. В ней приведена краткая характеристика синтетических счетов и открываемых к ним субсчетов: раскрыты их структура и назначение, экономическое содержание обобщаемых на них фактов хозяйственной деятельности, порядок отражения наиболее распространенных фактов. Описание счетов бухгалтерского учета по разделам приводится в последовательности, предусмотренной Планом счетов бухгалтерского учета.
Принципы, правила и способы ведения организациями бухгалтерского учета отдельных активов, обязательств, финансовых, хозяйственных операций и др., в том числе признания, оценки, группировки, устанавливаются положениями и другими нормативными актами, методическими указаниями по вопросам бухгалтерского учета.
По Плану счетов бухгалтерского учета и в соответствии с настоящей Инструкцией бухгалтерский учет должен вестись в организациях (кроме кредитных и государственных (муниципальных) учреждений) всех форм собственности и организационно-правовых форм, ведущих учет методом двойной записи.
(в ред. Приказа Минфина РФ от 08.11.2010 N 142н)
(см. текст в предыдущей редакции)
На основе Плана счетов бухгалтерского учета и настоящей Инструкции организация утверждает рабочий план счетов бухгалтерского учета, содержащий полный перечень синтетических и аналитических (включая субсчета) счетов, необходимых для ведения бухгалтерского учета.
План счетов бухгалтерского учета представляет собой схему регистрации и группировки фактов хозяйственной деятельности (активов, обязательств, финансовых, хозяйственных операций и др.
) в бухгалтерском учете. В нем приведены наименования и номера синтетических счетов (счетов первого порядка) и субсчетов (счетов второго порядка).
Для учета специфических операций организация может по согласованию с Министерством финансов Российской Федерации вводить в План счетов бухгалтерского учета дополнительные синтетические счета, используя свободные номера счетов.
Субсчета, предусмотренные в Плане счетов бухгалтерского учета, используются организацией исходя из требований управления организацией, включая нужды анализа, контроля и отчетности. Организация может уточнять содержание приведенных в Плане счетов бухгалтерского учета субсчетов, исключать и объединять их, а также вводить дополнительные субсчета.
Порядок ведения аналитического учета устанавливается организацией исходя из настоящей Инструкции, положений и других нормативных актов, методических указаний по вопросам бухгалтерского учета (основных средств, материально-производственных запасов и т.д.).
В Инструкции после характеристики каждого синтетического счета дана типовая схема корреспонденции его с другими синтетическими счетами.
В случае возникновения фактов хозяйственной деятельности, корреспонденция по которым не предусмотрена в типовой схеме, организация может дополнить ее, соблюдая единые подходы, установленные настоящей Инструкцией.
📜 Инструкция по применению Мирамистин® 💊 Состав препарата Мирамистин® ✅ Применение препарата Мирамистин® 📅 Условия хранения Мирамистин® ⏳ Срок годности Мирамистин® Сохраните у себя Поиск аналогов Описание лекарственного препарата Мирамистин® (Miramistin®) Основано на официальной инструкции по применению препарата, утверждено компанией-производителем
и подготовлено для печатного издания справочника Видаль 2023 года. Дата обновления: 2022.06.30 Владелец регистрационного удостоверения:ИНФАМЕД, ООО (Россия) Произведено:ИНФАМЕД К, OOO (Россия) Контакты для обращений:ИНФАМЕД ООО (Россия) Код ATX: D08AJ (Четвертичные аммониевые соединения) Активное вещество: бензилдиметил-миристоиламино-пропиламмоний (benzyldimethyl-myristoylamino-propylammonium) Group Группировочное наименование Лекарственная форма
Форма выпуска, упаковка и состав препарата Мирамистин®Раствор для местного применения в виде бесцветной, прозрачной жидкости, пенящейся при встряхивании.
Вспомогательные вещества: вода очищенная — до 1 л. Флаконы полиэтиленовые 50 мл, 100 мл (1) с аппликатором урологическим с навинчиваемым колпачком. Каждый флакон 50 мл, 100 мл, 150 мл, 200 мл, 500 мл вместе с инструкцией по применению помещают в картонную пачку. Для стационаров: 12 флаконов по 500 мл без пачки с равным количеством инструкций по применению помещают в коробку из картона для потребительской тары. Клинико-фармакологическая группа: Антисептик для местного применения Фармако-терапевтическая группа: Антисептическое средство Фармакологическое действиеМирамистин® обладает широким спектром антимикробного действия, включая госпитальные штаммы, резистентные к антибиотикам. Препарат оказывает выраженное бактерицидное действие в отношении грамположительных (Staphylococcus spp., Streptococcus spp., в т.ч. Streptococcus pneumoniae, и других), грамотрицательных (Pseudomonas aeruginosa, Escherichia coli, Klebsiella spp.), аэробных и анаэробных бактерий, определяемых в виде монокультур и микробных ассоциаций, включая госпитальные штаммы с полирезистентностью к антибиотикам. Оказывает противогрибковое действие на аскомицеты рода Aspergillus и рода Penicillium, дрожжевые (Rhodotorula rubra, Torulopsis glabrata) и дрожжеподобные грибы (Candida albicans, Candida tropicalis, Candida krusei, Pityrosporum orbiculare (Malassezia furfur)), дерматофиты (Trichophyton rubrum, Trichophyton mentagrophytes, Trichophyton verrucosum, Trichophyton schoenleini, Trichophyton violacent, Epidermophyton Kaufmann-Wolf, Epidermophyton floccosum, Microsporum gypseum, Microsporum canis), а также на другие патогенные грибы, в виде монокультур и микробных ассоциаций, включая грибковую микрофлору с резистентностью к химиотерапевтическим препаратам. Обладает противовирусным действием, активен в отношении сложноустроенных вирусов (вирусы герпеса, вирус иммунодефицита человека). Мирамистин® действует на возбудителей заболеваний, передающихся половым путем (Chlamydia spp., Treponema spp., Trichomonas vaginalis, Neisseria gonorrhoeae). Эффективно предотвращает инфицирование ран и ожогов. Активизирует процессы регенерации. Стимулирует защитные реакции в месте применения за счет активации поглотительной и переваривающей функции фагоцитов, потенцирует активность моноцитарно-макрофагальной системы. Обладает выраженной гиперосмолярной активностью, вследствие чего купирует раневое и перифокальное воспаление, абсорбирует гнойный экссудат, способствуя формированию сухого струпа. Не повреждает грануляции и жизнеспособные клетки кожи, не угнетает краевую эпителизацию. Не обладает местнораздражающим действием и аллергизирующими свойствами. ФармакокинетикаПри местном и наружном применении препарат не обладает способностью всасываться через кожу и слизистые оболочки. Показания препарата Мирамистин®Оториноларингология:
Стоматология:
Хирургия, травматология:
Акушерство, гинекология:
Комбустиология:
Дерматология
Венерология:
Урология:
Открыть список кодов МКБ-10
Режим дозированияОториноларингология Взрослые и дети При гайморитах Во время пункции верхнечелюстную пазуху промывают достаточным количеством препарата Мирамистин®. При остром и хроническом наружном отите В наружный слуховой проход с помощью пипетки закапывают 5 капель препарата 4 раза/сут или, вместо закапывания, в наружный слуховой проход аккуратно вводят марлевую турунду, смоченную препаратом, 4 раза/сут. Курс лечения — 10 дней. Тонзиллиты, фарингиты и ларингиты Дети 3-6 лет: однократное нажатие на головку насадки-распылителя или 3-5 мл на одно полоскание, 3-4 раза/сут. Дети 7-14 лет: двукратное нажатие на головку насадки-распылителя или 5-7 мл на одно полоскание, 3-4 раза/сут. Дети старше 14 лет и взрослые: 3-4-кратное нажатие на головку насадки-распылителя или 10-15 мл на одно полоскание, 3-4 раза/сут. Длительность терапии составляет от 4 до 10 дней в зависимости от сроков наступления ремиссии. Стоматология Взрослые и дети При стоматитах, гингивитах, пародонтитах рекомендуется полоскание ротовой полости 10-15 мл препарата, 3-4 раза/сут. Хирургия, травматология, комбустиология С целью лечения и профилактики вторичного инфицирования ран поверхность раны орошают раствором препарата Мирамистин®. Марлевые тампоны, смоченные препаратом Мирамистин®, фиксируют на поверхности раны. В случае необходимости возможно тампонирование раны и/или свищевых ходов во время выполнения хирургических манипуляций. Возможно проведение активного дренирования ран и/или полостей. Суточный расход препарата Мирамистин® составляет до 1 л. Акушерство и гинекология Взрослые Профилактика и лечение нагноений послеродовых травм, ран промежности и влагалища, послеродовых инфекций Препарат Мирамистин® применяется в виде влагалищных орошений до родов (5-7 дней), в родах (после каждого влагалищного исследования). При родоразрешении женщин путем кесарева сечения непосредственно перед операцией обрабатывают влагалище, во время операции — полость матки и разрез на ней, а в послеоперационном периоде вводят тампоны, смоченные препаратом Мирамистин® во влагалище с экспозицией 2 ч в течение 7 дней. Лечение воспалительных заболеваний проводится курсом в течение 2 недель путем внутривлагалищного введения тампонов с препаратом Мирамистин®, а также методом лекарственного электрофореза. Комплексное лечение воспалительных заболеваний в гинекологии (вульвовагинит) В виде влагалищных орошений или введения тампона, смоченного препаратом Мирамистин® с экспозицией 2 ч в течение 7-14 дней. Продолжительность лечения и кратность введения определяются по назначению врача. Для удобства влагалищного орошения рекомендуется использование гинекологической насадки. Дети Способ применения, продолжительность лечения и кратность введения определяются по назначению врача. Дерматология Взрослые и дети Лечение и профилактика пиодермий и дерматомикозов, кандидозов кожи и слизистых оболочек, микозов стоп Препарат Мирамистин® наносят на пораженный участок кожи путем протирания стерильными марлевыми тампонами, обильно смоченными препаратом. Мирамистин® применяется 3 раза/сут на пораженных участках кожи. Венерология Взрослые Профилактика заболеваний, передающихся половым путем Применение препарата Мирамистин® эффективно в течение 2 ч после полового акта. Содержимое флакона с помощью аппликатора урологического ввести в мочеиспускательный канал на 2-3 мин: мужчины — 2-3 мл препарата; женщины — 1-2 мл препарата ввести в мочеиспускательный канал и 5-10 мл во влагалище (для удобства рекомендуется использование гинекологической насадки). Обработать кожу внутренних поверхностей бедер, лобка, половых органов. После процедуры рекомендуется не мочиться в течение 2 ч. Урология Взрослые В комплексном лечении уретритов и уретропростатитов проводят впрыскивание в уретру 2-3 мл препарата 1-2 раза/сут, курс — 10 дней. Дети Способ применения, продолжительность лечения и кратность введения определяются по назначению врача. Правила использования препарата Препарат готов к применению. Указания по использованию упаковки с насадкой-распылителем
Указания по использованию упаковки 50 мл или 100 мл с гинекологической насадкой
Указания по использованию упаковки 100 мл, 150 мл, 200 мл с мерным стаканчиком Для использования препарата в виде полоскания количество препарата, необходимое на одно полоскание, следует отмерить с помощью мерного стаканчика, входящего в комплект. Если после лечения улучшения не наступает или симптомы усугубляются, или появляются новые симптомы, необходимо проконсультироваться с врачом. Препарат следует применять только согласно тому способу применения и в тех дозах, которые указаны в инструкции. Побочное действиеПараметры частоты нежелательных реакций определяются следующим образом: очень часто (≥1/10), часто (≥1/100 до <1/10), нечасто (≥1/1000 до <1/100), редко (≥1/10000 до <1/1000), очень редко (<1/10000), частота неизвестна (не может быть оценена по имеющимся данным). Очень редко (<1/10000): легкое жжение, которое проходит самостоятельно, через 15-20 сек, и не требует отмены препарата; аллергические реакции. Если отмечаются побочные эффекты, указанные в инструкции по медицинскому применению, или они усугубляются, или отмечаются любые другие эффекты, не указанные в инструкции, пациенту необходимо сообщить об этом врачу. Противопоказания к применению
Не рекомендуется применение препарата в форме спрея для орошения горла и миндалин детям в возрасте до 3 лет ввиду риска реактивного ларингоспазма. Применение при беременности и кормлении грудьюСогласно имеющимся данным применение препарата при беременности и в период грудного вскармливания возможно, т.к. препарат не обладает системным действием при его применении в соответствии с инструкцией, однако остается на усмотрение врача. Применение у детейПрепарат применяют у детей по показаниям. Применение у пожилых пациентовСпециальные ограничения для применения у пациентов пожилого возраста отсутствуют. Особые указанияИспользование одного флакона препарата более чем одним лицом может привести к распространению инфекции. ПередозировкаСлучаев передозировки препарата при местном или наружном применении не зарегистрировано. Лекарственное взаимодействиеПри одновременном применении с антибиотиками отмечено усиление их противобактериальных и противогрибковых свойств. Условия хранения препарата Мирамистин®Препарат следует хранить в недоступном для детей месте при температуре не выше 25°С. Срок годности препарата Мирамистин®Срок годности — 3 года. Не применять препарат по истечении срока годности. Условия реализацииПрепарат отпускают без рецепта. Контакты для обращений
Сохраните у себя |
прим. 0.01%: фл. 50 мл, 100 мл 1 шт. в компл. аппликатором урологическим; фл. 100 мл, 150 мл, 200 мл 1 шт. в компл. с насадкой-распылителем; фл. 500 мл 1 или 12 шт.
1
4
ч. периодонтит)
0
0
В случае невозможности полоскания допускается местное применение марлевых или ватных тампонов, смоченных раствором препарата Мирамистин®.
В послеродовом периоде Мирамистин® вводят с помощью тампонов, смоченных 50 мл препарата с дальнейшей экспозицией на протяжении 2 ч в течение 5 дней.
Содержимое флакона с помощью гинекологической насадки ввести во влагалище и произвести орошение.
,Как создать личное руководство пользователя для работы
Познакомьтесь со своими товарищами по команде и узнайте, как эффективно работать с ними, поделившись руководствами пользователя, которые включают в себя коммуникативные предпочтения и многое другое.
Прыжки к инструкциям
Время подготовки
30 мин
Время выполнения
60 минут
Люди
2-10
Мое руководство по пользователю
их, поделившись руководствами пользователя, которые включают настройки связи и многое другое.
Прыгание к инструкциям
Время подготовки
30 мин
Время выполнения
60 минут
человек
2-10
Знакомство с своими товарищами по команде и как эффективно работать с ними, используя пользовательский человек.
, которые включают настройки связи и многое другое.
Время подготовки
30 минут
Время работы
60 минут
Люди
2-10
Перейти к инструкциям
Мое руководство пользователя в действии
Член команды делится своим руководством пользователя в Confluence через Zoom.
На этом слайде в своем руководстве пользователя коллега рассказывает, как ей нравится получать отзывы.
Эта команда собирается, чтобы поделиться своими руководствами пользователя лично и в видеочате.
Инструкции по проведению этой игры
1. Подготовка 30 мин
Перед собранием попросите каждого члена команды заполнить руководство пользователя, используя один из предоставленных шаблонов, если хотите, или создав свой собственный . Сообщите им, что они могут выбирать любые подсказки, которыми им удобно делиться.
Подсказка: СОБСТВЕННАЯ ИНФОРМАЦИЯ
Мы предоставили подсказки в шаблоне, но мы рекомендуем вам сделать его по-своему, используя смелые цвета, множество мемов и случайные факты.
2. Подготовьте сцену 5 МИН.
Сообщите своей команде следующее в начале встречи:
- Это задание предназначено для того, чтобы члены команды поняли, как поддерживать идеальные условия друг друга для достижения наилучших результатов сделано.
- Никто не будет вынужден делиться тем, чем ему неудобно делиться.
- Это собрание — безопасное место. Ничто из того, что они разделяют, не будет использовано против них.
Совет: НОВЫЕ СОТРУДНИКИ
При приеме на работу новых сотрудников добавьте создание и представление руководства пользователя в качестве задачи на первые 90 дней.
Совет: НАЧНИТЕ
Создавайте и делитесь руководствами пользователя при запуске нового проекта.
3. Поделиться 55 МИН
Каждый член команды делится своим руководством пользователя с командой и отвечает на любые вопросы товарищей по команде по содержанию.
ПРИМЕР: ОБЩЕНИЕ
Вот как может выглядеть раздел «Как мне нравится общаться» в руководстве пользователя пространство Confluence команды или другое пространство для обмена файлами, чтобы будущие товарищи по команде могли быстро освоиться.
Варианты
Попробовать на вкус
Для более короткой встречи попробуйте ограничить шаблон вопросами о рабочем времени, идеальной среде, предпочтениях в общении и стилях обучения, прежде чем углубляться во что-то более длинное и глубокое.
Добавьте немного индивидуальности
Попросите членов команды вместе пройти личностный тест или пройти тренировку, например, DiSC, Поиск сильных сторон или Майерс-Бриггс. Поделитесь и обсудите результаты в команде.
Остались вопросы?
Начните общение с другими пользователями Atlassian Team Playbook, получите поддержку или оставьте отзыв.
Остались вопросы?
Начните общение с другими пользователями Atlassian Team Playbook, получите поддержку или оставьте отзыв.
Ознакомьтесь с другими играми
От нашей команды к вашей
Будьте в курсе последних игр, советов и трюков с нашей ежемесячной рассылкой.
Адрес электронной почты
Спасибо!
Как создавать онлайн, инструменты и рекомендации
Руководства пользователя чрезвычайно важны для пользователей, стремящихся понять продукты и процессы.
Иногда они даже юридически требуются для того, чтобы компания продавала свою продукцию клиентам.
Клиенты часто обращаются к вашему руководству пользователя, прежде чем обратиться в службу поддержки клиентов, поэтому ваше руководство может сэкономить вам деньги на расходах на поддержку.
Стоит потратить значительное время и усилия на руководство пользователя, чтобы обеспечить наилучшее обслуживание клиентов. В этом посте мы рассмотрим определение руководства пользователя, рекомендации по его написанию и несколько примеров программного обеспечения, которое вы можете использовать для написания своего руководства.
Что такое руководство пользователя?
Руководство пользователя — это документ, предоставляемый пользователю, который помогает беспрепятственно использовать определенную систему, продукт или услугу. Его также называют инструкцией по эксплуатации или руководством пользователя. Такие документы содержат подробную информацию об операциях, стандартах и рекомендациях, руководствах по устранению неполадок, функциях и многом другом.
Руководства пользователя обычно содержат пошаговые инструкции, помогающие пользователям использовать ваш продукт и возможные способы устранения неполадок на случай, если что-то пойдет не так. Его не обязательно читать от корки до корки, он должен содержать оглавление и индекс, чтобы помочь клиентам найти раздел, который имеет отношение к их проблеме.
В начале руководства должно содержаться руководство по началу работы, чтобы клиенты могли быстро освоиться. Он может быть доставлен в печатном виде или в Интернете, или в сочетании того и другого.
Типы руководств пользователя
Существует несколько различных типов руководств пользователя, которые вы должны учитывать, приступая к технической коммуникации.
1. Руководство по эксплуатации
Руководство по эксплуатации содержит основные инструкции, которые сообщают пользователям, как лучше всего использовать продукт.
2. Учебное пособие
Учебное пособие представляет собой набор инструкций, в которых пользователям сообщается, как выполнять задание, процесс или задачу.
3. Руководство по техническому обслуживанию
Руководство по техническому обслуживанию представляет собой набор инструкций, которые информируют пользователей о том, как поддерживать работу оборудования в различные периоды его эксплуатации.
4. Руководство пользователя
Как упоминалось ранее, руководства пользователя представляют собой технические информационные документы, помогающие пользователям в работе с продуктом.
5. Руководство по эксплуатации
Руководство по эксплуатации — это документация с информацией о вашей компании, включая роли, обязанности и процессы.
6. Руководство по организационной политике
Руководство по организационной политике документирует политики, процедуры и лучшие практики компании.
7. Руководство по стандартным операционным процедурам (СОП)
Стандартная операционная процедура содержит четкие инструкции, сообщающие членам организации, как выполнять определенные процессы.
Какой бы тип руководства вы ни писали, есть несколько общих тем, которым вы можете следовать при написании документации.
Читайте также: Создание технического руководства: как, типы и примеры
Что делает руководство пользователя хорошим?
1. Простой язык
Не используйте витиеватую прозу при написании руководства пользователя. Ваше письмо должно быть ясным, простым и легким для понимания, без использования словаря.
Используйте короткие предложения и слова, чтобы сделать ваш текст доступным. Если вам нужно использовать технический термин, обязательно дайте ему определение или ссылку на глоссарий.
2. Визуализация
Без иллюстраций ваше руководство пользователя превратится в длинную стену текста, в которой нет ничего, что могло бы его разбить или привлечь внимание пользователей. Таким образом, многие руководства пользователя могут быть скучными для чтения.
Сделайте свою документацию интерактивной, добавив соответствующие изображения, диаграммы и видео, чтобы ваши пользователи могли взаимодействовать с ними.
Уточните, к какому шагу инструкций относятся ваши визуальные эффекты, чтобы пользователи могли их понять.
3. Логическая иерархическая структура
Ваши пользователи должны иметь возможность осуществлять поиск в вашем руководстве пользователя, руководствуясь предопределенной структурой. Ваше содержимое должно иметь логическую иерархическую структуру, которая имеет смысл для пользователей, когда они ищут информацию.
4. Содержимое с возможностью поиска
В идеале вам необходимо сделать содержимое доступным для поиска пользователями, предоставив его в виде онлайн-базы знаний с четкой и заметной панелью поиска. Ваша панель поиска должна предугадывать термины, которые вводят ваши пользователи, и выполнять поиск как по заголовку, так и по основному содержанию ваших статей.
5. Четкие темы и релевантные статьи
Вы должны организовать свой контент по четким темам, которые имеют смысл для содержащихся в них статей. У вас не должно быть слишком много тем для вашей документации, иначе это может быть перегружено для пользователей, и в то же время не должно быть слишком много уровней подтем, иначе ваша документация может быть трудной для понимания.
6. Отзывы и обзоры
Активно запрашивайте отзывы пользователей о вашем руководстве пользователя и принимайте во внимание их предложения по улучшению. Узнайте, действительно ли ваши пользователи добиваются успеха с помощью вашего руководства и помогает ли оно им решать свои проблемы.
Как создать руководство пользователя
1. Определите пользователей
Первое, что вам нужно сделать при написании руководств пользователя, это точно определить, кто ваши пользователи – демографические данные, их потребности, проблемы и требования для начала. Выяснение того, кто является вашей аудиторией, говорит вам, сколько деталей вам нужно включить в свое руководство пользователя и как вы должны представить свой контент.
2. Сосредоточьтесь на проблеме
Все руководства пользователя направлены на решение проблемы пользователей. Вам нужно выяснить, что это за проблемы, чтобы создать действительно полезное руководство и решить проблему с помощью ваших инструкций.
Конечно, если есть глубоко укоренившаяся проблема с самим продуктом, то ее следует исправить, а не просто предоставить обходные пути в документации.
3. Используйте последовательные шаги по порядку
Ваши инструкции должны быть разбиты на последовательные шаги, представленные в порядке пронумерованного списка. Попробуйте организовать его таким образом, чтобы самая простая задача была представлена первой.
Сохраняйте только одну точку на шаг, чтобы вашим пользователям было легко следовать инструкциям. Сообщите своим пользователям, как будет выглядеть выполненная задача, прежде чем они перейдут к следующему шагу.
4. Карта пути пользователя
Проведите исследование того, как пользователи на самом деле используют ваш продукт, чтобы вы могли подготовить соответствующую документацию для каждой точки взаимодействия на пути пользователя. Основная цель — увидеть продукт с точки зрения пользователя и точно понять, как он взаимодействует с вашим брендом.
Частью вашей карты пути пользователя является точное определение проблемы или цели, которую преследует пользователь при использовании вашего продукта. Возможно, вам придется разделить пользователей на разные сегменты, поскольку у пользователей могут быть разные причины использования вашего продукта.
5. Выберите шаблон
Чтобы ваша документация была согласованной, важно разработать набор шаблонов, которые вы можете использовать для написания своего контента. Ваш шаблон должен быть четким и простым для понимания и включать жизненно важные компоненты, необходимые для каждого документа.
Ваш шаблон может включать:
- Место для введения
- Разделы и подразделы
- Последовательные шаги
- Предупреждения и вызовы
- Место для вывода
Обязательно укажите размер шрифта, контраст текста и фона и последовательно используйте цветовое кодирование.
6. Напишите простой и понятный контент
Если вы следовали предыдущим шагам, понимаете своих пользователей и пишете ясно и убедительно, ваш контент должен быть простым и понятным.
Тщательно редактируйте свою документацию, чтобы оптимизировать содержимое и убедиться, что оно включает только самые важные элементы, необходимые пользователям для выполнения задачи.
Каждый шаг ваших инструкций должен включать только одну задачу, чтобы пользователи могли работать с вашей документацией шаг за шагом, не путаясь.
7. Относитесь ко всем пользователям как к непрофессионалам
Не думайте, что ваши пользователи имеют техническое образование – выбранный вами язык должен относиться к пользователям как к непрофессионалам, избегая жаргона и специальных терминов, если в этом нет крайней необходимости. Лучше всего исходить из того, что ваши пользователи ничего не знают о продукте, и быть как можно более откровенным в вашей документации.
8. Протестируйте инструкции вместе с продуктом на неопытных пользователях
Когда вы написали руководство пользователя, вы должны указать, работает ли оно на пользователях, которые никогда раньше не использовали ваш продукт.
Обратите внимание на то, где пользователи застревают в вашей документации, и соответствующим образом измените свой контент.
Пользователи должны иметь возможность использовать вашу документацию, не обращаясь в службу поддержки. Вы должны предоставить все, что им нужно знать, в своем руководстве.
9. Создавайте контент, используя практический подход
При написании руководства пользователя обязательно включите практические примеры вместе с инструкциями, чтобы показать пользователям результаты, которых они могут ожидать, если выполнят задание. Ваши инструкции должны четко объяснять, что пользователи увидят или услышат, и какую обратную связь они могут получить от продукта.
10. Объясните символы, значки и коды заранее
Вам может понадобиться использовать символы, значки и коды в вашей документации для представления определенной информации. Убедитесь, что вы объяснили их заранее, чтобы пользователи не ломали головы.
Читайте также: Как писать инклюзивную документацию?
Лучшие технические инструменты для написания руководств пользователя
1.
Document360Document360 идеально подходит для создания руководств для ваших пользователей. Вы можете использовать современный редактор Document360 для написания контента и организации его с помощью менеджера категорий, который позволяет создавать до шести уровней подкатегорий. При использовании редактора вы можете использовать редактор WYSIWYG или редактор Markdown, который позволяет создавать контент в Markdown.
Руководства пользователя Document360 поставляются с мощной поисковой системой, позволяющей пользователям находить в вашем контенте то, что им нужно, а сайт оптимизирован для чтения на любом устройстве. Вы можете расширить возможности Document360 с помощью расширений других приложений, включая Drift, Intercom и Freshchat, а также многих других.
Вы можете настроить свое руководство пользователя с помощью Конструктора домашней страницы, который позволяет добавлять ссылки, изменять цвета, включать категории из вашего руководства и многое другое.
Вы можете настроить более детально, используя CSS и JavaScript.
Документирование, хранение и обмен техническими руководствами стало проще.
Заказать демонстрацию
2. Adobe FrameMaker
Adobe FrameMaker — это инструмент для создания справки, предназначенный для создания документов для Интернета. Вы можете создавать интеллектуальный структурированный контент с использованием XML и DITA, который подходит как для начинающих, так и для опытных пользователей. FrameMaker упрощает импорт содержимого из Microsoft Word, поэтому вам не нужно выполнять перенос вручную.
FrameMaker хорошо поддерживает мультимедиа, поэтому вы можете создавать иммерсивный контент с изображениями и видео. Вы можете беспрепятственно сотрудничать с экспертами в предметной области, используя настольные и онлайн-сервисы Adobe Acrobat.
Он очень хорошо обрабатывает большие документы со сложными стилями и использует среду разработки на основе шаблонов.
Он публикуется в различных форматах, таких как PDF, EPUB, мобильное приложение и адаптивный HTML5. Вы можете донести свой контент до мировой аудитории благодаря поддержке XLIFF в FrameMaker.
Читайте также: Что такое Help Authoring Tool: преимущества, функции и варианты использования
3. Markdown
Markdown – это упрощенный язык разметки, используемый для создания форматированного текста в редакторе. Это инструмент преобразования текста в HTML для веб-писателей, который позволяет вам легко создавать свои руководства пользователя и размещать их в Интернете для своих пользователей.
Преимущество использования Markdown заключается в том, что синтаксис делает его максимально читаемым при написании документации. Документ в формате Markdown выглядит так, как будто его можно опубликовать без разметки тегами или инструкциями по форматированию.
4. Paligo
Paligo — это система управления компонентным контентом для команд.
Он предоставляет сквозную платформу для интеллектуального контента и единый источник достоверной информации, поэтому вы можете создавать свои руководства пользователя с повторным использованием контента и структурированной авторской разработкой.
Paligo обеспечивает разработку на основе тем и интеллектуальное повторное использование контента, поэтому вы можете выпустить свою документацию за долю времени, которое обычно требуется для создания готового продукта. Paligo упрощает для всей вашей команды совместную работу над контентом с помощью облачной платформы.
Вы можете персонализировать свой контент для разных аудиторий и публиковать его везде, где это необходимо вашим клиентам, включая HTML5, печать PDF, SCORM eLearning, Zendesk, Salesforce, GitHub, BitBucket, Amazon S3 и многое другое. Вам нужно написать свой контент только один раз, а затем вы можете изменить его назначение одним нажатием кнопки.
Paligo поставляется с системой управления версиями, предназначенной для авторов контента.
Он включает в себя историю версий и откат, ветвление версий и управление выпусками, поэтому вам не нужно беспокоиться о сложности традиционных систем контроля версий, ориентированных на разработчиков.
Читайте также: 20 лучших средств документирования программного обеспечения 2022 года
Заключение
Руководства пользователя являются неотъемлемой частью вашего продукта или услуги, и вы должны посвятить соответствующее количество времени и усилий их созданию. Доступен ряд различных инструментов, каждый из которых подходит для разных организаций с различными потребностями. Не торопитесь, чтобы протестировать их и решить, какой из них подходит вам лучше всего.
Предоставление полезного руководства пользователя приведет к увеличению количества довольных клиентов, которые будут дольше оставаться в вашей компании. Ваша команда обслуживания клиентов будет благодарна вам за предоставление метода самообслуживания, который помогает свести к минимуму количество клиентов, обращающихся в службу поддержки.