Самостоятельно разработанная WeDoctor архитектура «EasyDoc» имеет открытый исходный код!

Что такое ИзиДок

• ЧТО: EasyDoc — это易配置的降本提效的项目文档系统
• ЗАЧЕМ:
  • Сокращение сложных проектов上手难度, чтобы улучшить взаимодействие с пользователем
  • Сгладить новый и старый состав проектной команды信息差
  • Перенести носитель бизнес-деталей проекта из开发者изменить на文档工具
• КАК: В процессе用户引导,обработать操作手册,страница说明文档,项目说明документация,关键点注解документация и т.д.
• Статус: EasyDoc инкубировался в WeDoctor Group более года, имеет доступ к более чем дюжине онлайн-приложений и всесторонне продвигается внутри группы. В то же время продвижение открытого исходного кода в сообществе,希望能给社区带来一点新鲜的血液, с нетерпением ждем вашего использования и доступа, если у вас есть какие-либо вопросы, оставьте комментарий или дайте нам свое мнение о github.
• Типичные сценарии: управленческий фон, сложные формы, сложные процессы, сложные взаимодействия 😉😉
• Неудобные сцены: проекты на большом экране, игровые проекты 🤣🤣

Происхождение EasyDoc

Давайте посмотрим на историю

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

• Полная бизнес-логика разбросана по диаграмме прототипа, системе ошибок, комментариям к коду и памяти человеческого мозга, которую нелегко восстановить и легко потерять.给项目的持续迭代带来了极大的可维护性成本
• Для долгосрочных итеративных проектов разработки только разработчики знают бизнес-детали, и новички просто не могут взять на себя управление. Как только разработка или продукт уйдет, бизнес-логика будет потеряна, и документ о передаче вообще не будет играть большой роли.给项目研发带了极大的可控性风险
• Внешнее руководство по эксплуатации в формате PDF из-за недостаточного внимания и частых итераций проекта всегда忘记及时更新, стать куриным ребром.
• Даже при наличии надежной документации можно столкнуться со многими проблемами во время конкретной работы процесса.用户体验很不好，并且要时常对用户或运营进行培训和24小时问题解答. Было бы неплохо иметь живое руководство пользователя или руководство по эксплуатации.

others

• Только приблизительное введение в проект, без введения страницы или введения модуля.
• Отсутствие руководства пользователя или непоследовательное руководство пользователя, странное использование и плохой пользовательский опыт
• Документы по эксплуатации есть, но комплексная операция многосистемного прыжка бессильна
• Никто не ведет деловые документы или затраты на обслуживание слишком высоки

Дизайнерские решения вышеуказанных проблем

• 项目文档:
  • Первый раз: всплывающее окно для пользователя при первом открытии страницы.介绍一次当前系统的背景、目标、功能、注意事项
  • Обновление: повторное всплывающее окно при реализации обновления документа проекта с помощью контроля номера версии.
  • Оглянитесь назад: если вам нужно продолжить чтение документа позже, вы можете просмотреть его, нажав кнопку EasyDoc в правом верхнем углу.
• 页面文档:
  • Открыть: нажмите кнопку EasyDoc в правом верхнем углу, чтобы отобразить弹窗查看当前页面的功能介绍а также使用注意事项Ждать
  • Обновление: обновите, обновив файл json соответствующей страницы.
• 页面关键点文档:
  • Открыть: нажмите кнопку EasyDoc в правом верхнем углу, чтобы отобразить对页面某个关键的逻辑点做注解备注, что удобно для понимания пользователями или разработчиками
  • Обновление: обновите, обновив файл json соответствующей страницы.
• 可编辑节点文档:
  • Открыть: щелкните кнопку EasyDoc в правом верхнем углу, чтобы отобразить, используемый для решения: «в архитектурной модели интерфейсной системы пользователя, отображаемую данные, редактирование фоновых систем и отображения данных, для решения сценария, где операция не Знайте, где изменить содержимое, отображаемое на фронт-конце
  • Обновление: обновите, обновив файл json соответствующей страницы.
• 用户引导:
  • Открыть: вызвать API EasyDoc для работы,复杂流程使用用户引导进行傻瓜式教学, и аннотировать ключевой документ шагов для улучшения понимания
  • Обновление: Front-end разработка и обслуживание
• 操作手册:
  • Открыть: нажмите кнопку EasyDoc в правом верхнем углу, чтобы открыть对多页面或多系统跳转的极复杂流程进行步骤化注解, пусть пользователь на странице实时实地实景Пожалуйста, обратитесь к соответствующему руководству по эксплуатации и следуйте инструкциям шаг за шагом.
  • ОБНОВЛЕНИЕ: обновление через json-файл документа действия проекта обновления.

Демонстрация использования видео EasyDoc

Демонстрационное видео EasyDoc Bilibili

Изменения и итерации выбора технологии EasyDoc

• Версия 1: typeciprt+rollup+less+jest

  Чтобы упаковать меньше, мы не использовали никакой UI-фреймворк и использовали rollup, да, мы группа молодых людей, которые стремятся к конечному 😎😎, но это заставило нас сильно страдать, когда мы использовали js для написания html ε= (´ο｀*) )) Тьфу. Мы решили использовать typescript для удобства сопровождения, что действительно улучшило качество нашего кода и, что более важно, заставило нас осознать важность качества кода.我们使用jest框架编写单元测试，这的确消耗了我们一些时间，但对于一个没有专职测试人员的架构项目，这样做非常有必要. Модульное тестирование значительно повышает надежность, ремонтопригодность, удобство использования и стабильность самостоятельно разработанных проектов.

• Машинописный текст версии 2+обновление+меньше+шутка+vue2

  Да, мы используем vue2 для рефакторинга js для написания кода dom, это не потому, чтоvdom可以给我们带来性能的提升，这点性能对于现代浏览器来说根本不是瓶颈. В основном потому, что ремонтопригодность DOM, написанного на js, слишком низкая😂😂, что также заставляет нас глубоко понимать значение трех основных фреймворков для фронтенд-разработки.

• Версия 3 vue3+ts+element-plus разрабатывает json-плагин визуальной конфигурации (подпакет, исходный код еще не открыт)

  Мы обнаружили, что интерактивная форма json-файла проекта, написанного фронтендом публично, действительно не очень дружелюбна к фронтенд-студентам, что, несомненно, оставляет ведение бизнес-документов фронтенд-студентам. В то время мы думали об этом так 🤔🤔:

  多年来前端由于不直接接触业务方和数据源，导致前端人员在项目组中充当开发资源没有地位没有思考没有发言权没有业务成长没有晋升机会；我们希望前端通过承担EasyDoc维护项目业务文档的方式来贴近、掌握、思考、反哺业务，提高前端在项目组中的地位和发言权，通过前端视角带给项目更多的价值增长。

  Однако, когда мы приступили к его продвижению, мы обнаружили, что у этого метода есть некоторые недостатки: 1. Продукты, тесты и студенты не могут изменять документы без разрешений внешнего кода. 2. Предварительное обслуживание всех документов может быть слишком тяжелым. 3. Некоторые фронтенды не хотят быть рядом с бизнесом, да и не должны быть рядом с бизнесом, и мы не можем заставлять других быть сложными. Поэтому мы разработали плагин для визуализации JSON-файла конфигурации, чтобы решить эту проблему.

• версия 4 лерна

  Чтобы ускорить отрисовку первого экрана, мы максимально уменьшили размер основного пакета, поэтому разделили некоторые подпакеты, что сделало наше хранилище кода слишком большим. Текущий разработчик стабилен, так что это не имеет значения, но开发人员频繁调整带来的仓库管理负担的隐患我们必须未雨绸缪提前解决😜😜. Поэтому мы используем lerna для объединения всего кода, связанного с EasyDoc, и единым образом управляем авторизацией и развертыванием npm.

Процесс обдумывания решения по внедрению технологии EasyDoc

• Технические требования: Нам нужно добавить текстовую заметку к проекту, странице или ярлыку
• Технические требования: Нам необходимо установить строгое взаимно-однозначное соответствие между div и бизнес-документом json.
• Решение 1. Используйте общедоступную программу Xpath для блогов.
  • Преимущество заключается в том, что исходный код страницы не является инвазивным; документация и код проекта полностью отделены друг от друга; любой может редактировать очень легко модифицировать
  • слабость это如果页面源码修改了会导致Xpath失效需要重新添加，而且那些失效了也不知道，对于频繁迭代的项目来说维护文档简直就是灾难🤣🤣
• Решение 2. Используйте инструкцию vue + всплывающую подсказку элемента, чтобы создать плагин документа
  • Преимущество в том, что dom заимствует возможности элемента без дополнительной разработки, а документ хранится в vue html рядом, что очень легко понять и модифицировать
  • слабость это只能前端维护文档，太依赖vue和element通用性差，文档侵入性太强
• Решение 3. Используйте пользовательский атрибут тега docId, чтобы установить связь между тегами и документами json.
  • Преимущество对源码入侵小，文档和源码解耦放在项目public文件夹里，后期通过可视化插件让所有人都能够轻松的编辑修改🤞🤞
  • Недостаток в том, что документ и проект полностью не развязаны, необходимость добавления docId в тег пока слабо навязчива
• Решил реализовать с помощью решения 3 после мозгового штурма

Установите html-тег и схему сопоставления документов json через docId

Организационная схема кода EasyDoc

Итерация продвижения проекта самоисследования архитектуры

• ✨试点运行很重要

  Проект самоисследования архитектуры не может предсказать отношение пользователей до того, как он будет запущен, поэтому в настоящее время пилотный проект очень необходим и ценен.通过试点项目观测产品的稳定性、易用性、用户使用姿势、用户学习成本等，可以在正式推广之后减少很多的风险和不确定性😊😊.

• запуск продукта

  Это отличный способ прорекламировать ваш архитектурный проект для всей компании через официальную презентацию, давая вам время рассказать о своем продукте и используя функцию записи экрана для продолжения продвижения. Он также может столкнуться со студентами на месте и собрать идеи, вдохновение и мнения студентов для улучшения продукта.不要害怕别人battle你，这是完善自身的一种非常有效的方式.

• Ищем потенциальных пользователей, хорошие продукты тоже должны хорошо продаваться

  机会不会主动来找你，你要主动去找机会. Больше обсуждайте деловые документы с другими продуктами бизнес-направления, фронтендом, тестированием и бэкендом, выслушивайте их жалобы, понимайте их болевые точки, сопереживайте их боли, запускайте наши продукты и демонстрируйте их, а также куйте железо, пока оно готово. горячо завоевать его; если его нельзя выиграть в тот же день, это также должно быть записано в протокол для ответного визита в будущем.

• ✨倾听用户的声音，不要反驳要及时响应

  用户并不在乎开发的技术实现细节和开发问题开发难点，用户只在意自己的痛点和什么时候能解决🤦‍♂️🤦‍♂️. Не опровергайте неправильную позу и образ мыслей пользователя, а направляйте его или приспосабливайтесь к нему. Вы должны знать: пользователь — это всего лишь ребенок, который может только кричать, и он ничего не может знать, и наша миссия — сделать так, чтобы ему было комфортно пользоваться нашими продуктами, а не кричать.

  • История 1: Мы пошли к определенному продукту для продвижения EasyDoc и надеялись, что она сможет получить к нему доступ.После прослушивания введения она также чувствовала себя очень хорошо, но бизнес ответов был слишком занят, и не было ограничения по времени, чтобы написать документ для доступа. Позже в работе продукта были жалобы на то, что продукт сложен в использовании и не будет использоваться.自从接入了EasyDoc后，产品反馈流程问题吐槽、咨询少了一大半🤦‍♀️🤦‍♀️，沟通成本骤降了很多，用户体验非常好. С тех пор она наш постоянный пользователь.
  • История 2: Всплывающее окно в правом верхнем углу EasyDoc изначально появлялось в состоянии наведения.В то же время многие имена пользователей приложений щелкают, чтобы выйти из системы, и выходят из системы в правом верхнем углу, поэтому его легко провести на панель EasyDoc по ошибке. Объясняем пользователю, почему должно появляться всплывающее окно при наведении? Этот шаг предназначен для экономии кликов пользователей, что является оптимизацией взаимодействия с пользователем. но用户并不关心我们的优化点，用户只关心误划问题🤷‍♀️🤷‍♀️, когда мы поняли, что наша оптимизация действительно дает пользователям побочные эффекты, мы решили удалить оптимизацию и изменить ее на всплывающее окно только по клику.
  • История 3: EasyDoc изначально был закреплен справа после всплывающего окна, в то же время многие страницы в фоновой системе имеют таблицы, и кнопки работы с таблицами тоже справа, поэтому наша панель блокирует кнопки операций пользователя , и пользователю нужно щелкнуть и переключить панель EasyDoc вперед и назад. Это очень негуманно, мы знаем об этой проблеме и готовимся оптимизировать ее в следующей версии. Но пользователь много раз спрашивал нас в течение 3 дней, когда это будет исправлено, и мы отвечали и итерировали другие оптимизации в следующей версии. но在用户眼里，我们改个小问题太慢了而且用户并不关心其他的优化🤷‍♂️🤷‍♂️. Когда мы это поняли, то вынесли это требование отдельно и выпустили в ночь на третий день.
  • История 4: Руководства по эксплуатации EasyDoc изначально были независимыми, поскольку каждое руководство по эксплуатации представляет собой независимый модульный блок. Тем не менее, пользователи считают, что они должны иметь возможность читать одно за другим или переходить друг к другу, и даже руководства по эксплуатации между различными системами могут быть связаны и перепрыгивать.我们非常想反驳用户你的使用姿势真是奇葩！简直是异想天开瞎搞乱搞🙌🙌。但是我们很有素质，我们认真考虑了用户诉求，重新定义了操作手册的操作方式满足了用户的痛点。用户真可爱.

• Болезнь пользователя - это итерационные цели и ценности

  软件即服务，用户的痛点就是价值点, трудно сделать хороший продукт за закрытыми дверями.

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

• ✨价值和意义（降本提效、业务增长）

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

  EasyDoc снижает расходы за счет размещения деловых документов开发期间стоимость поиска, стоимость связи, стоимость доработки, стоимость передачи, повышение эффективности запуска проекта, освоения и разработки; EasyDoc снижает стоимость за счет переноса деловых документов用户使用期间Время понимания, стоимость исследования, стоимость проб и ошибок улучшают пользовательский опыт и уровень удержания пользователей, а также способствуют росту бизнеса.

• Согласование целей (управление ожиданиями)

  мы часто используемЧетырехсекторный тайм-менеджментрасставить приоритеты в списке дел, но мы часто упускаем из виду проблему,同一个自研项目对于你的优先级和老板的优先级是不同的🤣🤣, это потому, что стандарт, который мы рассматриваем, больше связан с ростом личных навыков и способностей, в то время как стандарт, рассматриваемый боссом, - это «приоритизация вещей, которые более ценны для компании». Поэтому нам необходимо согласовать цели текущего квартального проекта самоисследования с начальником, прежде чем каждый раз ставить квартальные цели.如果没有对齐目标这一步很有可能你既没有功劳也没有苦劳还要挨批浪费人力资源😒😒！.

• Хочешь результатов, получай результаты, получай результаты (замкнутое мышление)

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

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

• ✨为什么要平行管理？

  Крупномасштабные проекты самоисследования архитектуры разрабатываются в сотрудничестве с командой, и между начальниками и подчиненными могут быть не лидерские отношения, а все равные ранги. В это время, когда мнения конфликтуют, трудно прийти к согласию, и никто не может принять окончательное решение. Если вы просите своего начальника принять решение каждый раз, когда у вас возникают разногласия, это заставит начальника почувствовать, что он слишком некомпетентен, чтобы поднимать шум. В настоящее время параллельное управление особенно важно.如果我们能充分发挥平行管理能力，争取虚线带领团队推进项目，对自己的领导能力有很大的提升，又能让团队取得很好的成果,Почему бы не сделать это?

  • История 1: Когда мы впервые собрались на встречу, чтобы обсудить, как это сделать, все молчали, не было ни процесса, ни модератора, ни лица, принимающего решения, ни протоколов совещаний, только бесконечные мозговые штурмы и баталии, что было хаотично. Когда собрание закончилось, я начал размышлять:为什么大家都这么厉害聚在一起却变得这么菜？😢😢В конце концов я узнал, что это было из-за того, что не было прочерченной роли лидера! Так что я начал пытаться подталкивать, брать на себя ответственность и контролировать каждую встречу через会前推演规划、会中掌控流程节奏、会后跟进落实任务，我们的会议开始变得高质高效.
  • История 2: Когда пользователи используют наши продукты, они будут давать отзыв каждому разработчику по частям, а затем они изменят его, когда станут бесплатными. Однако, когда бизнес загружен, отзывы пользователей надолго останутся без внимания. Мы не можем привлекать наших разработчиков к ответственности, потому что они занимаются бизнесом, но также факт, что отзывы наших пользователей не учитывались. Итак, мы начали думать有必要建立用户反馈问题处理流程🤔🤔:
    • 1. Собирайте и записывайте отзывы пользователей и информацию о разработке с помощью документов для совместной работы нескольких человек.
    • 2. Дайте разработчикам, расписанию, прогрессу и отзывам пользователей
    • 3. Своевременно координируйте другие последующие действия по разработке, когда индивидуальные графики конфликтов или блокировок
    • 4. После того, как проблема появится в сети, проверьте и своевременно уведомите пользователя обратной связи, чтобы записать отзыв об изменении.
    • 5. Регулярно проверяйте ход решения проблемы, чтобы не забыть
    • 6. Регулярно анализируйте проблемы и основные причины для улучшения продуктов и процессов НИОКР.

• Как управлять параллельно?

  ✨平行管理其实是全局统筹的能力. 1.先对架构目标进行WBS拆分, все задачи участника были разумно выделены для детального рассмотрения разделения. Необходимо полностью учитывать способности, желание, объем задач и результаты каждого члена команды. 2. Вкл.会讨论解决方案并分配任务, для проблем мы должны сначала выдвигать разумные предложения и давать волю субъективной инициативе каждого; для назначения задач отдавать приоритет пожеланиям каждого и поддерживать баланс, насколько это возможно, чтобы давать предложения и причины назначения задач. 3. Сделать всех участников填写每项任务开发时间、完成时间, оценить обоснование и рекомендовать корректировки. 4. В每个时间节点前关心下同学的进度и справиться с этим. 5. Каждый大阶段完成后或遇到重大问题拉个会议集体复盘Проведите мозговой штурм, подведите итоги прошлых неудач и внесите коррективы в планы на будущее.

• Параллельные элементы управления

  Образцовое видение, субъективная инициатива, осведомленность владельца, способность к планированию, эмпатия и убеждение людей в морали. . .

Разработчик и сопровождающий

• Ли Юнтонг😜😜
• Ян Ичжэнь😎😎
• Хунин✌✌
• Цзяо Чуанкай😉😉
• Цюань Минъян😘😘
• Хуан Дандань🤞🤞

иди вперед, не оглядывайся

Конечно, то, что в настоящее время является открытым исходным кодом, является лишь верхушкой айсберга EasyDoc.Полная картина наших планов на будущее такова:

• Основной пакет EasyDoc: загрузка панелей и всплывающих окон,动态加载其他SDK副包
• Подпакет EasyDoc Visual Configuration: предоставляет возможность визуального добавления возможности написания бизнес-документов в формате json.
• Поддокументы с исходным кодом EasyDoc и сопоставлением элементов страницы: Предоставить. Нажмите на Div страницы, чтобы найти возможность соответствовать тегу VUE.
• Подпакет EasyDoc User Behavior Analysis для сбора отзывов: предоставляет возможность собирать информацию о поведении и отзывах пользователей.
• Фон управления документами EasyDoc:提供存放和修改业务文档的能力，实现文档和项目完全解耦，最终建设成为集团文档的收录系统

Путь к успеху никогда не бывает гладким, а повороты на этом пути завораживают. На пути саморазвития архитектуры EasyDoc мы испытали страсть к тяжелой работе и корыто неуверенности в себе и бессмысленности Мы не только испытали очень хорошее поощрение похвалы и творчества пользователя босса, но и столкнулся с безжалостными жалобами пользователей, так сложно пользоваться.我们能做的只有坚持不懈、化茧成蝶😎😎. Когда мы оглядываемся назад после этого путешествия, мы все еще очень благодарны за рост, который принес нам этот опыт.虽然我们的产品可能无法带给社区多大的帮助多大的声音，但是我们也希望以我们的经历带给大家一些启发和信心💖💖, чтобы вдохновить студентов на создание более приоритетных продуктов для самостоятельного исследования архитектуры и вселить в них некоторую уверенность в том, что вы добьетесь успеха.向前走、别回头，路上春色正好，天上太阳正晴✌✌.

дальнейшее чтение

• Учебное пособие по самостоятельно разработанной архитектуре WeDoctor "EasyDoc"
• Шаблоны проектирования, которые вы должны знать о версии ts
• Вы должны знать методологию анализа больших заводских проблем.
• Лучшие практики рефакторинга кода на больших фабриках. Вы действительно знаете, как рефакторить код?
• Нужно ли разбираться в тонкостях исходного кода фреймворка?
• [анализ исходного кода vue3] начало исходного кода

Адрес гитхаба EasyDoc

GitHub.com/we front/tower-…

не забудь дать нам点赞✨✨Заказать звезду🤞🤞（づ￣3￣）づ╭❤～