Выпущена система управления документами Wizard с открытым исходным кодом 1.0

WizardЯвляется системой управления документами с открытым исходным кодом, адрес проектаGitHub.com/Нет рационального мышления/Я…. Этот пунктяОн был разработан в 2017 году. Сначала я просто хотел сделать инструмент, который может управлять документами Swagger внутри компании, но в последние два года я периодически добавлял в него различные функции, и вот, наконец, решился. Вышла версия 1.0, на данный момент поддерживает три типа управления документами

Markdown: Это также основной тип документа Мастера, наиболее часто используемый тип документа, используемый группой исследований и разработок для связи.Wizardв, даEditor.mdПроект был расширен такими функциями, как шаблон документа, Json в таблицу, вставка и загрузка изображений и т. д.
Swagger:служба поддержкиOpenAPI 3.0Спецификация, встроенная в официальный редактор Swagger и интегрированная в проект Wizard посредством пользовательской разработки, поддержки шаблонов документов, полноэкранного редактирования и функций автоматической синхронизации документов.
Table: этот тип документа аналогичен электронной таблице Excel, в которой используетсяx-spreadsheetПроект, заложенный в Wizard, еще не идеален

В настоящее время в основном включает следующие функции

Swagger, Markdown, Управление документами табличного типа
Управление историей изменений документа
Сравнение различий в модификации документа
Управление правами пользователей
Управление проектной группой
Единая аутентификация LDAP
поиск по документам, поиск по тегам
режим чтения
Комментарии к документации
уведомление
Обмен документами
Функция статистики

Если вы хотите быстро опробовать функции мастера, есть два способа:

Онлайн-опыт, пожалуйста, посетитеwizard.aicode.cc/, в настоящее время предоставляется только опыт некоторых функций, пожалуйста, обратитесь к предварительному просмотру функций и инструкциям по использованию.Wiki.
Используйте Docker для создания полного сервиса Wizard.

Перейдите в корневой каталог проекта и выполнитеdocker-compose up, вы можете быстро создать сервис Wizard, получить доступ к адресуhttp://localhost:8080.

источник

Чтобы побудить всех писать документы для разработки, мы изначально выбралиShowDocПроект использовался как инструмент управления документами, в то время размер команды тоже был очень маленьким, и все писали какие-то простые документы для разработки прямо в Markdown. Позже, с ростом команды, разделением фронтенда и бекенда и уточнением командного разделения труда, только использование Markdown стало натягиваться.В это время мы впервые подумали об использовании более популярной индустрии с открытым исходным кодом.Swaggerдля создания документации по разработке. Но существует так много документов Swagger, должно быть место для их хранения, верно?

Недостаточно использовать Swagger для документации в проекте, он подходит только для управления документами API, есть много других документов, таких как проектные документы, блок-схемы, документы архитектуры, технические решения, изменения базы данных и другие документы, которые нужно поддерживать вместе. Поэтому я решил использовать свое свободное время для разработкиИнструмент управления документацией, поддерживающий Markdown и Swagger., это,Wizardпроект.

Сначала я планировал использовать язык Go для разработки, но через несколько дней обнаружил, что использование Golang для разработки веб-проектов слишком неэффективно (быстрая эффективность разработки, а не производительность, Golang по-прежнему очень хорош для разработки интерфейса API), многие часто требуются используемые функции. Чтобы реализовать это самостоятельно, я отказался от использования Golang и переключился на использование PHP-фреймворка Laravel для разработки. Таким образом, несмотря на то, что проект был создан 27 июля 2017 г., фактическое время начала должно быть 31 июля 2017 г.

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

Управление правами пользователейЧто касается метода управления разрешениями Gitlab, различается только личность пользователя.администраториобычный пользователь, создавгруппа пользователейОсуществлять детальное управление разрешениями пользователей, и каждый проект поддерживает отдельные разрешения на чтение и запись для пользователей.
Группировка проектовВ Wizard документы организованы в блоки проектов.Вначале это было нормально.Потом проектов становилось все больше и больше,появилась функция группировки проектов.Структура проектов была организована в виде каталог.
История изменений документаКаждый раз, когда документ изменяется, Wizard делает снимок, чтобы избежать потери, вызванной неправильным изменением документа.Документ можно быстро восстановить через историю документа, а ключевые операции, такие как изменение, добавление и удаление документа, будут регистрируется в журнале аудита. Отображается в виде последних событий.
Сравнение документовПри групповой помощи многие люди часто изменяют один и тот же документ.Во избежание конфликтов, после изменения документа, когда другие люди отправляют старую историческую версию, система подскажет пользователю, что содержание документа изменилось, и пользователь может воспользоваться функцией сравнения документов, узнать, что изменилось в документе.
режим чтенияПри использовании проектора для отображения документа, чтобы прийти к техническому решению, чтобы уменьшить ненужные помехи, используется режим чтения, и отображается только содержимое документа, чтобы обеспечить лучшее отображение.
поиск документовБыстро находите нужные документы с помощью функции поиска.В настоящее время документы можно искать по названию документа, а функция полнотекстового поиска будет добавлена в будущем.
поддержка LDAPМногие компании используют LDAP для унифицированного управления учетными записями своих сотрудников. Сотрудники используют одну и ту же учетную запись для входа в различные системы, такие как Jira, Wiki, Gitlab и т. д., во всех системах внутри компании. Wizard также обеспечивает поддержку LDAP. быстрый доступ к единой системе учетных записей компании с помощью всего нескольких простых конфигураций.
Приложение к документу,Обмен документами,статистика,сортировка документов,Управление шаблонами,Комментарии к документации ...

О коде

Проект принятLaravelРазработка фреймворка, текущая версия обновлена до последней версии 5.8 (в начале 5.4, полностью обновлена). Чтобы повысить эффективность разработки и сохранить простоту архитектуры, в процессе разработки мы всегда избегаем введения слишком большого количества внешних компонентов и изо всех сил стараемся использовать различные компоненты, предоставляемые Laravel, такие какAuthentication,Authorization,Events,Mail,Notificationsд., очень подходит для изучения фреймворка Laravel.

Суммировать

Если вы ищете бесплатное ПО с открытым исходным кодомУправление документами разработки/APIинструменты, подумайтеWizardПроект вас не разочарует. Если вы новичок в PHP или Laravel и хотите найти проект, чтобы научиться веб-разработке с помощью Laravel, этот проект нельзя пропустить!

Наконец, это также основная часть этой статьи, поторопитесьStarПросто дай мнеStarКакие ! Если вы можете внести еще несколько выпусков или PR, будет еще лучше 😄!