На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Маутик
- Технический писатель:
- Фавор Кельвина
- Название проекта:
- База знаний
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
Абстрактный
База знаний — это централизованное хранилище, в котором информация хранится, систематизируется и затем распространяется. При внешнем использовании база знаний — это место, куда пользователи могут обратиться, чтобы узнать все, что им когда-либо понадобится, о продуктах или услугах, организации и отрасли компании. С другой стороны, внутренняя база знаний обычно используется как способ, позволяющий сообществу/пользователям сотрудничать и распространять все знания и информацию компании внутри компании. Хотя содержание конкретных баз знаний варьируется в зависимости от множества факторов, чаще всего они включают информацию о том, как начать использовать определенные продукты, максимально эффективно использовать расширенные функции и преодолеть распространенные проблемы или проблемы. Основное преимущество создания и представления базы знаний вашей аудитории заключается в том, что она позволяет вам предоставлять глубокую, мгновенную информацию по запросу и ответы членам вашей аудитории/пользователям/сообществу без необходимости делать это индивидуально.
База знаний Mautic — это центральное хранилище учебных пособий, практических руководств и передового опыта по темам, связанным с Mautic — напрямую (например, как что-то делать в Mautic) или косвенно (например, более общие маркетинговые стратегии).
На момент написания этой статьи база знаний Mautic была совершенно новой и неполной, и сообщество Mautic хочет использовать этот проект для улучшения способа предоставления подробной информации по запросу в пользовательскую документацию, чтобы конечные пользователи могли иметь удобство использования Mautic. Просмотр базы знаний Mautic был весьма информативным, но требовались обновленные учебные пособия и практические руководства, а также создание новых, а также соответствующих версии Mautic 3x.
Мои первые впечатления от изучения существующей документации. В настоящее время база знаний Mautic доступна https://kb.mautic.org/. Некоторые учебные пособия, практические руководства и передовые практики в документации устарели, являются скудными или неполными, а также не содержат информации о текущей версии mautic.
Почему предложенное вами улучшение превосходит нынешнее/области, в которые я хотел бы внести свой вклад? Предлагаемое улучшение будет направлено на улучшение и обеспечение эффективности, последовательности и спокойствия для любого конечного пользователя. Он будет содержать письменные учебные пособия, практические руководства, лучшие практики и связанные с ними изображения, а также инструкции и объяснения того, как использовать каждую функцию mautic, актуальные, простые в навигации и понятные.
Анализ
База знаний Mautic была написана на плоском файле CMS Grav и теме KLB4. Я много исследовал способы улучшения документации базы знаний.
Цели проекта
- Просмотрите базу знаний.
- Обновите учебные пособия и практические руководства для версии Mautic 3x.
- Создайте ресурсы для недавно созданной базы знаний сообщества Mautic.
- Напишите серию практических руководств и руководств, которые помогут пользователям Mautic более эффективно устанавливать, настраивать и использовать приложение.
- Обновите видеоруководство, чтобы оно соответствовало версии Mautic 3x.
- Удалите устаревшие изображения и информацию.
- Перепишите базу знаний, чтобы ее было легче понять.
- Обеспечить правильную реализацию руководства по стилю/шаблона документации базы знаний.
График
До 1 августа
- Продолжайте вносить вклад в организацию.
- Познакомьтесь поближе с документацией базы знаний и текущей версией Mautic.
- Изучите новые методы и навыки технического письма, которые пригодятся при реализации проекта.
Сплочение сообщества (1 августа – 1 сентября)
- Настройте канал связи и время (из-за разницы во времени)
- Уточнить мои цели и установить ожидания обеих сторон.
- Узнайте больше о сообществе и продукте
- Обсуждение предлагаемой структуры документации с наставниками и другими членами организации.
- Доработать предлагаемые функции и другие изменения, которые необходимо внести в существующую документацию.
Период документации
- Неделя 1 (2 сентября – 22 ноября)
- В эти периоды я работал непосредственно со своими наставниками, чтобы:
- Просмотрите базу знаний.
- Обновите учебные пособия и практические руководства для версии Mautic 3x.
- Создайте ресурсы для недавно созданной базы знаний сообщества Mautic.
- Напишите серию практических руководств и руководств, которые помогут пользователям Mautic более эффективно устанавливать, настраивать и использовать приложение.
- Обновите видеоруководство, чтобы оно соответствовало версии Mautic 3x.
- Удалите устаревшие изображения и информацию.
- Перепишите базу знаний, чтобы ее было легче понять.
- Обеспечить правильную реализацию руководства по стилю/шаблона документации базы знаний.
- Принимая во внимание периодичность выпусков, поскольку команда разработчиков будет занята выпуском второстепенных функций.
Оценка проекта (25–29 ноября 2019 г.)
- Отправьте отчет о проекте и оценку моих наставников
- Напишите и отправьте отчет о моем опыте участия в Сезоне Документов.