Цифровая документация: Лучшие практики для информирования и вдохновения

Avatar of Author
Tal F
on May 04, 2021 · · filed under Документация по продукции Лучшие практики

От бумаги к пикселям

Всего несколько десятилетий назад казалось, что каждый бизнес использует бумагу для документации. Контракты, политики, записи совещаний - все было на бумаге, распечатывалось и передавалось по кругу, а не прикреплялось и анализировалось по электронной почте.

С развитием технологий у предприятий появилось больше места для хранения документации, а также компьютерные системы, необходимые для доступа сотрудников к этим цифровым документам. Это ознаменовало начало перехода от бумажных документов к пикселям.

Современный мир цифровой документации предлагает множество преимуществ, но проблемы остаются. Документация используется для передачи информации как внутреннему персоналу, так и внешним клиентам. Это означает, что последовательность содержания, легкость доступа и простота управления являются обязательными. Напротив, непоследовательная, недоступная и неуправляемая цифровая документация может снизить способность вашего предприятия эффективно передавать информацию.

Чтобы обеспечить простоту и последовательность, предприятия должны следовать передовым методам работы с цифровой документацией. Это включает в себя дизайн, форматирование, выбор типов файлов и управление цифровой документацией.

В этой электронной книге мы обсудим передовые методы работы с цифровой документацией и потенциальное влияние этих изменений на бизнес. Может ли лучшая цифровая документация способствовать росту доходов и привлечению клиентов? Как компании могут преобразовать свою цифровую документацию, чтобы повысить ценность для клиентов с помощью системы управления документацией, или DMS?

Позвольте нам ответить на эти вопросы!

Преимущества цифровой документации

Прежде чем мы обсудим, что и как лучше всего использовать в цифровой документации, сначала нам следует понять преимущества цифровой документации:

  • Простота управления -- Цифровой документацией легче управлять, чем бумажными документами. Бумажная документация требует места в офисе под картотеку и требует ручной архивации каждого бумажного документа. Цифровое хранение документов освобождает офисную недвижимость и упрощает управление с помощью функции поиска и структуры папок.

Как показано в исследовании Software Advice, офисные работники тратят в среднем шесть часов в неделю на поиск бумажных документов. Кроме того, офисные работники тратят в среднем восемь часов в неделю на создание отчетов из бумажных документов, при этом 94% отметили, что система управления документами (DMS) облегчает этот процесс.[1]

  • Удобство доступа - Этими цифровыми документами можно обмениваться практически в режиме реального времени по электронной почте или через облачное хранилище. Это устраняет необходимость в рассылке писем, исключая почтовые или курьерские расходы. Это также повышает скорость реагирования, поскольку получателям больше не нужно ждать несколько дней, пока придет письмо. Кроме того, цифровая документация может быть размещена на вашем веб-сайте или в социальных сетях, что повышает удобство доступа для клиентов.

Знаете ли вы, что, по данным Gartner, на каждый $1, потраченный на печать документов, приходится еще $6, потраченных на обработку и распространение этих документов? Более того, половина всех печатных документов выбрасывается в течение 24 часов.[[2]] (file:///C:/Users/Ciaran/Google%20Drive/Articles%20Work/All%20Articles/SoSEO/Docsie/Docsie%20Content/eBook%20-%20Digital%20Documentation%20Best%20Practices%20to%20Inform%20and%20Inspire.docx#_ftn2)

  • Безопасность и управление -- Если бумажная документация не спрятана за замком и ключом, она небезопасна. Любой может прочитать ее, сделать копию и поделиться ею по своему усмотрению. Напротив, цифровая документация может управляться с помощью ролевого контроля доступа (RBAC) для предоставления доступа только тем, кому это необходимо.

Даже правительства не застрахованы от утечек бумажных данных: Министерство по делам ветеранов США называет бумажную документацию причиной 98% утечек данных[[3]] (file:///C:/Users/Ciaran/Google%20Drive/Articles%20Work/All%20Articles/SoSEO/Docsie/Docsie%20Content/eBook%20-%20Digital%20Documentation%20Best%20Practices%20to%20Inform%20and%20Inspire.docx#_ftn3).

  • Экологические преимущества -- Как люди, так и компании ищут способы уменьшить свой экологический след. Цифровая документация - это один из путей, по которому они могут пойти. По данным организации Green America, за последние 40 лет потребление бумаги выросло на 400%, а на долю этой отрасли приходится 4% мирового потребления энергии[[4]] (file:///C:/Users/Ciaran/Google%20Drive/Articles%20Work/All%20Articles/SoSEO/Docsie/Docsie%20Content/eBook%20-%20Digital%20Documentation%20Best%20Practices%20to%20Inform%20and%20Inspire.docx#_ftn4). Перейдя на цифровую документацию, предприятия могут сократить использование бумаги для борьбы с вырубкой лесов - сохранение деревьев для поглощения выбросов углерода и поддержания среды обитания животных.

Лучшие методы работы с цифровой документацией на Docsie

Цифровая документация способна изменить обмен знаниями, публикацию и маркетинг в масштабах всего предприятия. Чтобы использовать этот потенциал, предприятия должны следовать передовым методам работы с цифровой документацией:

Согласование DMS с потребностями бизнеса

Система управления документами (DMS) - это основа, которая помогает предприятиям хранить и управлять своей документацией. После написания контента он загружается в DMS для хранения и распространения. DMS централизует хранение документации, обеспечивая единый источник знаний для всего предприятия. Она функционирует подобно электронной библиотеке, классифицируя документы по отделам или продуктам, с функцией поиска для упрощения обмена знаниями. Отсюда команды маркетинга и поддержки могут обмениваться документацией, публикуя ее на веб-сайтах и в социальных сетях или в ответ на запросы клиентов.

Docsie - это DMS, которая упрощает работу с документами для вашей команды. Каждому предприятию необходим способ хранения и обмена документацией, как для того, чтобы внутренние сотрудники могли узнать о своих должностных обязанностях, так и для того, чтобы клиенты могли узнать, как использовать ваш продукт или услугу. Документы по введению в должность сотрудников, руководства по использованию продукта, шаблоны для общения с продавцами - все эти элементы можно хранить и публиковать с помощью правильного решения DMS.

Какая документация существует в настоящее время по вашим продуктам и услугам? Используют ли ваши сотрудники шаблоны и рамки при общении с клиентами? Можете ли вы легко хранить, обмениваться и публиковать документацию внутри компании? Задайте эти вопросы при рассмотрении решения DMS, такого как Docsie, и убедитесь, что ваша DMS соответствует потребностям бизнеса.

Сосредоточьтесь на совместимости

Цифровая документация может повысить доступность, но только при использовании совместимых форматов файлов. Это важно для загружаемой документации, поскольку некоторые клиенты могут быть не в состоянии открыть файл. Это также относится к внутренней документации, где один сотрудник, использующий PDF, а другой - DOCX, может вызвать фрагментацию формата файла, что заставит других сотрудников переходить на другой пакет программного обеспечения или конвертировать файл в другой формат, чтобы сделать его доступным.

Открытые форматы файлов, такие как docx, xlsx и pptx для Microsoft Office или открытый формат документов (ODF) для OpenOffice, идеально подходят для обеспечения максимальной совместимости. Документы Adobe PDF распространены, но менее совместимы, поскольку требуют наличия программы просмотра PDF. Подумайте, кто будет обращаться к этим документам, и храните документацию в формате, рассчитанном на максимально широкий круг пользователей.

Docsie - отличный вариант для широкой совместимости документов. Когда текст загружается в редактор книг Docsie, он сохраняется в формате файла JavaScript Object Notation (JSON) с открытым исходным кодом. Более подробную информацию об экспорте документов и о том, как Docsie позволяет легко конвертировать их в форматы DOC, PDF, Markdown (MD) и HTML, вы можете найти [здесь] (https://portals.docsie.io/docsie/docsie-documentation/using-docsie/?doc=/docsie-editor/exporting-content/).

Действенная обратная связь

Отзывы пользователей и сотрудников о документации крайне важны. Если в документации не хватает информации, она содержит неверные сведения или ее просто трудно читать - читатели будут стараться извлечь из нее хоть какую-то пользу. Кроме того, обратная связь может помочь вам улучшить существующую документацию, чтобы обеспечить большую ценность для клиентов, способствуя успеху бизнеса благодаря качественному обмену знаниями.

Docsie Vocally - это универсальная служба мониторинга и реагирования на отзывы. Он позволяет читателям оценивать отдельные фрагменты документации по шкале от одного до пяти, сопровождая их комментариями, объясняющими причины оценки. Владельцы и администраторы Docsie могут читать эти отзывы, получая представление об успехах и недостатках вашей документации.

Базы знаний самообслуживания предназначены для минимизации требований к поддержке, но это также означает, что клиенты вряд ли будут продолжать работать с плохой документацией - вместо этого они будут искать альтернативу у конкурентов, предоставляющих лучшую документацию. Для решения этой проблемы Docise Vocally записывает взаимодействие пользователей в процессе чтения документации. Это позволит выявить, где они столкнулись с проблемой в документе, и какое содержание вызвало проблему. Авторы могут использовать эту обратную связь для редактирования документации и действовать в соответствии с отзывами пользователей. Со временем это позволит повысить качество знаний о документации, расширив возможности клиентов по оказанию помощи самим себе.

Расширение возможностей клиентов - это отличный способ привлечь новый бизнес, снизить затраты и удержать клиентов. По данным Zendesk[[5]] (file:///C:/Users/Ciaran/Google%20Drive/Articles%20Work/All%20Articles/SoSEO/Docsie/Docsie%20Content/eBook%20-%20Digital%20Documentation%20Best%20Practices%20to%20Inform%20and%20Inspire.docx#_ftn5), около 67% клиентов предпочитают самообслуживание разговору по телефону. Forrester Research и Oracle также обнаружили, что самообслуживание может снизить затраты на поддержку на 11 долларов за звонок[[6]] (file:///C:/Users/Ciaran/Google%20Drive/Articles%20Work/All%20Articles/SoSEO/Docsie/Docsie%20Content/eBook%20-%20Digital%20Documentation%20Best%20Practices%20to%20Inform%20and%20Inspire.docx#_ftn6). Наконец, в исследовании Microsoft подчеркивается, что 90% клиентов ожидают возможности самообслуживания[[7]] (file:///C:/Users/Ciaran/Google%20Drive/Articles%20Work/All%20Articles/SoSEO/Docsie/Docsie%20Content/eBook%20-%20Digital%20Documentation%20Best%20Practices%20to%20Inform%20and%20Inspire.docx#_ftn7).

Подводя итог, можно сказать, что клиенты предпочитают и ожидают качественного самообслуживания, а предоставление такой возможности может значительно снизить затраты на поддержку. Создав базу знаний самообслуживания в Docsie и улучшив качество документации с помощью обратной связи через Docsie Vocally, вы сможете удовлетворить меняющиеся требования клиентов с помощью цифровой документации. Подробнее о Docsie Vocally [здесь] (https://www.docsie.io/vocally/).

Версионирование документов

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

Это важная передовая практика работы с цифровой документацией. Клиентам могут понадобиться старые версии вашего программного обеспечения для совместимости с их оборудованием, или они просто решат не обновляться до новой версии. Таким образом, компании всегда должны удовлетворять потребности своих пользователей, независимо от номера используемой версии.

Docsie решает эту проблему с помощью версионирования документов. Когда вы обновляете документ в Docsie, вы можете сохранить предыдущие версии в целях резервирования. Клиенты второй версии вашего сервиса могут выбрать нужную документацию, а клиенты первой версии по-прежнему имеют доступ к более старой документации. Это называется фрагментацией; когда ваша клиентская база разделена на несколько версий одного и того же программного обеспечения. Docsie уменьшает влияние фрагментации, обеспечивая доступность знаний независимо от используемой версии.

Версионирование документов обеспечивает доступность нужной информации, когда она необходима. Это также помогает отслеживать ситуацию, особенно когда несколько авторов работают над одним и тем же материалом. Версионирование также сокращает дублирование, объединяя документацию для удобства доступа.

Регулярно ли ваш бизнес обновляет свою документацию? Испытывают ли ваши клиенты трудности с поиском нужной информации для текущих и прошлых версий вашего программного обеспечения и услуг? Если да, то, возможно, пришло время применить передовую практику версионирования документов с помощью такой системы DMS, как Docsie. Более подробную информацию о версионировании документов Docise вы можете найти [здесь] (https://portals.docsie.io/docsie/docsie-documentation/using-docsie/?doc=/docsie-editor/managing-versions/).

Привычки документирования персонала

Ваши сотрудники создают документацию, но они также могут создавать проблемы с документацией. На этапе подготовки черновика авторы могут использовать разные размеры или типы шрифтов, устаревшие иконки и иллюстрации. Эти различия легко пропустить сотрудникам, которые работают с контентом каждый день, но клиенты, скорее всего, заметят их. Результатом является несогласованность документации, вызванная несогласованностью подхода к созданию и публикации контента в вашем штате.

Docsie помогает компаниям бороться с несогласованностью контента с помощью Docsie Documentation Hub. Вы можете установить тип и размер шрифта по умолчанию, добавить логотипы компании или иллюстрации, а также определить параметры таблицы стилей CSS для использования на веб-сайте компании или в базе знаний. Эти параметры будут передаваться из Docsie на любую веб-страницу со встроенным контентом Docsie, используя одинаковые цвета, шрифты и логотипы везде, где публикуется ваш контент.

Это упрощает управление контентом и рабочие процессы публикации. Вместо того чтобы редактировать отдельные страницы, компании могут один раз задать рамки оформления контента в Docsie и применять эти изменения повсеместно. Это известно как централизованное управление или оркестровка. Процесс редактирования каждого документа или страницы по отдельности может показаться выполнимым для небольших библиотек контента, но этот процесс не будет эффективно масштабироваться по мере роста обширности и глубины библиотеки.

В целом, Docsie работает над тем, чтобы защитить ваши рабочие процессы управления контентом в будущем, минимизируя административную нагрузку низкого уровня. Если начать работу с учетом масштаба, то можно легко управлять большими библиотеками контента - один раз установить рамки дизайна контента и развернуть их повсюду с помощью Docsie. Вы можете узнать больше о Docsie Customized Documentation Hubs, используя Docsie Manager [здесь] (https://www.docsie.io/docsie_manager/).

Централизованное хранение документации

Что касается централизации, то места хранения документов могут помогать или мешать управлению и публикации рабочих процессов. Вы можете хранить документацию в интрасети или на сайте SharePoint, в Dropbox или Google Drive, в локальных или облачных разделах хранилища. Каждый из этих вариантов работает сам по себе, но может привести к хаосу при одновременном использовании.

Сотруднику нужен доступ к документу. Документ хранится на сайте SharePoint. Сотрудник загружает его и сохраняет в разделе хранения своей учетной записи. Инструмент синхронизации бизнес-файлов автоматически загружает его в облако. Сотрудник отправляет документ через Slack своему коллеге. Это четыре копии одного и того же документа, циркулирующие в вашей ИТ-сети, с децентрализацией по четырем различным службам или инструментам.

Docsie решает проблему децентрализованного хаоса путем централизации документов в одном месте хранения. Когда вы загружаете документ, Docsie помещает его на полку. Мы относимся к документам как к книгам, а каждая полка заполняется книгами, образуя библиотеку контента. Сотрудники могут войти в Docsie, чтобы найти всю вашу документацию, с фильтрацией, которая предоставляет соответствующую документацию по отделам или руководящему составу с использованием ролевого контроля доступа (RBAC). Отсюда сотрудники могут публиковать документы непосредственно на вашем сайте, редактировать текст документации, проверять различные версии и просматривать отзывы клиентов или коллег.

Теперь, когда сотруднику нужен доступ к документу, ему достаточно открыть Docsie. Они могут искать документы, экспортировать в распространенные форматы файлов и обмениваться прямыми ссылками на книги или полки Docsie. Для внешних пользователей владельцы и администраторы могут приглашать их для прямого доступа к авторизованным книгам и полкам Docsie без ущерба для безопасности. Это как папки и файлы на жестком диске, но с небольшой магией Docsie! Вы можете узнать больше о полках и книгах Docsie [здесь] (https://www.docsie.io/features/).

Управление документами Риски и соответствие нормативным требованиям

Большинство документации будет создаваться для общественного достояния. Тем не менее, некоторая документация может быть конфиденциальной. В связи с этим возникает необходимость в управлении рисками и соблюдением нормативных требований (GRC). Политики GRC можно использовать для управления доступом к конфиденциальным документам, контроля разрешений на документы для авторов и читателей, а также для предотвращения случайной публикации документации на стадии черновика.

Docsie использует контроль доступа на основе ролей (RBAC) для управления разрешениями на платформе. Именно так Docsie помогает предприятиям управлять рабочими процессами GRC, определяя роли пользователей и назначая разрешения на основе старшинства или отдела. Эти роли включают в себя просмотрщик, редактор, администратор и владелец. Просмотрщикам предоставляется доступ к документам только для чтения, а редакторам - для чтения и записи. Администраторы могут назначать роли для управления тем, кому разрешено читать, писать или и то, и другое для каждой книги или полки. Владелец может управлять каждым пользователем и документом в организации Docsie и является единственной ролью пользователя, которая может удалить всю организацию. В данном примере организацией может быть Docsie, а полки содержат книги по различным функциональным возможностям Docsie.

В заключение следует отметить, что GRC важна для управления доступом к документации. При слишком ограниченном доступе сотрудники не смогут работать с документацией. При слишком широком доступе сотрудники могут случайно опубликовать незаконченную документацию или получить доступ к конфиденциальным документам, которые предназначены для руководителей и менеджеров. Docsie поможет вам найти баланс между доступом и безопасностью, благодаря чему платформа подходит для хранения документов любого типа.

Этот документ является конфиденциальным, как я могу предотвратить несанкционированный доступ? Как я могу дать своей команде разрешение на запись, а другим командам предоставить доступ только для чтения? Внештатному писателю нужно разрешение на редактирование этого документа, как это сделать? Если ваш бизнес задается этими вопросами, у Docsie есть ответы! Более подробную информацию об управлении разрешениями Docsie вы можете найти [здесь] (https://portals.docsie.io/docsie/docsie-documentation/using-docsie/?doc=/workspace-administration/managing-and-understanding-permissions/).

Командное взаимодействие

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

Каким процессам следуют ваши сотрудники при работе над документацией? В качестве примера можно привести поиск существующих документов на сетевом диске и их загрузку на компьютер. Затем автор может отправить окончательный вариант по электронной почте коллеге для дальнейшей проверки. Затем одобренный проект может быть загружен в систему управления контентом (CMS) для публикации. Позже, в течение дня, кто-то замечает проблему и отправляет аннотированную версию обратно писателю через Slack. Этот рабочий процесс может работать, но его можно упростить.

Docsie сокращает количество необходимых инструментов благодаря широким возможностям совместной работы. Вы можете находить документы в Docsie, писать и редактировать, делиться изменениями с членами команды, общаться и аннотировать, а также публиковать в Интернете, не выходя из панели Docsie. Это устраняет необходимость в загрузке, выгрузке, отправке по электронной почте и управлении CMS, позволяя вам просто управлять своими документами с помощью Docsie! Члены команды могут быть отмечены с помощью @mention, разговоры в чате изолированы для каждой книги Docsie, а внешние внештатные сотрудники могут быть легко приглашены для полноценной совместной работы в любом месте.

Благодаря минимизации количества необходимых инструментов сотрудники могут сосредоточиться на создании контента, а не на переключении между программами. Это ускоряет рабочие процессы создания контента, сводя к минимуму бесполезные клики, а комментарии и предложения коллег легко доступны на правой панели инструментов. Больше никакого обмена ссылками, никаких устаревших версий документов, никаких потерянных электронных писем или сообщений в чате - все, что связано с вашими документами, централизовано в Docsie.

Применяйте лучшие практики к своим документам с помощью Docsie

По мере того, как мы переходим от бумаги к пикселям, правильное управление документацией становится жизненно важным. Применяя эти лучшие практики к цифровой документации, компании могут создавать и распространять знания, которые обеспечивают реальную ценность для клиентов, оптимизируя рабочие процессы и снижая затраты. Вопрос только в том, как применять эти лучшие практики?

Вот тут-то и приходит на помощь Docsie. Docsie основана на этих передовых методах работы с документацией, применяя их автоматически для оптимизации рабочих процессов создания, управления и публикации контента. Платформа разработана для работы со всеми видами документации, в тесном соответствии с типичными требованиями DMS для бизнеса. При импорте и экспорте документации Docsie использует открытые и совместимые форматы файлов для повышения доступности. С помощью Docsie Vocally компании могут читать и учитывать отзывы клиентов о документации, повышая качество знаний и сокращая количество ошибок в контенте. Версионность документов позволяет сохранять исторические версии для сохранения информации. Рамки брендинга и дизайна контента можно установить один раз и применять повсеместно с помощью Customized Documentation Hub. Все хранится в одном месте - на портале Docsie Portal, поэтому сотрудники могут быстро найти документ, а не искать его на компьютере, облачном диске или в электронной почте. Разрешения могут быть установлены для управления GRC, предотвращая несанкционированный доступ к конфиденциальным документам. Наконец, коллеги могут общаться, обмениваться, связывать, прикреплять и предоставлять доступ подрядчикам для централизованной совместной работы в Docsie.

Создавайте документацию, которая понравится вашим клиентам, без лишних сложностей. Если ваш бизнес ищет решение для DMS, попробуйте Docsie! Просто свяжитесь с нашим отделом продаж, который с удовольствием проведет для вас 15-минутную демонстрацию платформы Docsie.


[1] https://www.softwareadvice.com/cms/industryview/go-paperless-with-document-management-software/.

[2] https://www.stopwaste.org/at-work/reduce-and-reuse/reduce-paper-use/the-impact-of-paper-waste#2

[3] https://fcw.com/articles/2013/08/08/va-data-breaches.aspx

[4] https://www.greenamerica.org/sites/default/files/inline-files/Paper%20Facts%202017.pdf

[5] https://www.zendesk.com/blog/searching-for-self-service/

[6] https://www.slideshare.net/UniWeb/the-total-economic-impact-of-click-to-call-and-click-to-chat

[7] https://download.microsoft.com/documents/en-us/dynamics/Global_State_of_Multichannel_Customer_Service_Report.pdf.pdf


Subscribe to the newsletter

Stay up to date with our latest news and products