Как вести базу знаний всех обновлений, исправлений и изменений, вносимых в проект?
Есть проект, в нем есть разные механизмы. Я хочу вести какую-нибудь базу знаний, в которую буду делать записи обо всех нововведениях, вносимых в проект. Главное: нужна какая-нибудь система "тегов", чтобы можно было для записи об обновлении указать в "теге" конкретный механизм, который это обновление затрагивает. И в будущем, если мне нужно будет просмотреть все обновления, связанные с каким-то конкретным механизмом, я бы искал по этим "тегам".
Наверняка есть какой-то термин для того, что я описал. И наверняка существуют сервисы, созданные для этого.
Системы контроля версий прошу не предлагать — база знаний должна быть отдельно от системы контроля версий.
Дополнительно:
Вопрос по git репозиторий ( кодовую базу) или бизнес логику приложения ?
Ответы:
Звучит как обычный таск-трекер. Если таски правильно сформулированы и оформлены - то все там можно будет найти.
1. commit message
2. task tracker (JIRA или аналоги)
Если их интегрировать друг с другом, будет еще и довольно просто перемещаться по коммитам
1. Формировать задачи в трекере, например gitlab
2. Использовать релизы
3. С выходом релиза фиксировать задачи/фикс багов, релиза в CHANGELOG.md
Рекомандую изучить ХайХаб (https://start.hihub.ru/):
- бесплатная база знаний с лимитов в 5 сотрудников (для небольших команд до 50 человек всего 4900 в месяц)
- древовидная система папок
- конечно есть теги
А еще плюсом станет расширенный поиск, по ключу изущется даже по прикрепленным документам. Есть поддержка языка разметки Markdown и конечно режим публикации кода.
решал подобные задачи связкой TeamCity + Jira + Confluence: При деплое на Prod TeamCity подтягивала список заплоенных stories из GIT. Далее небольшой скрипт формировал страницу в Confluence, подтягивая детали stories из Jira. Завершалось это все сообщение в Slack c ссылкой на полученную страницу.
Это требует договоренностей с командой разработки, например, user story Id должно присутствовать в описани коммита.
Можно в git коммитах писать комментарии с тегом. И задача хранения уже будет решена.
Задача поиска - это тоже интересный вопрос. Ну как вариант можно список коммитов раз
в сутки сливать в текстовый отчет и индексировать через ElasticSearch.
Confluence, обычно в нем ведут базу знаний, также там есть теги - labels.
Опишите проблему, и специалист поможет с настройкой, исправлением ошибки или доработкой сайта. Подберём понятный план работ без лишней переписки.
Пока нет других ответов. Будьте первым, кто поможет автору.
Ответить на вопрос
Для ведения базы знаний всех обновлений, исправлений и изменений, вносимых в проект, рекомендуется использовать систему управления версиями (Version Control System, VCS). Одним из самых популярных инструментов для этой цели является Git.
Git позволяет отслеживать изменения в коде, создавать ветки для разработки новых функций, объединять изменения из разных веток, откатываться к предыдущим версиям и многое другое.
Для начала работы с Git необходимо установить его на свой компьютер. После этого можно создать репозиторий для проекта, где будут храниться все изменения.
Принцип работы с Git заключается в коммитах, которые представляют собой сохраненные состояния проекта. При каждом изменении кода необходимо делать коммит с описанием внесенных изменений. Таким образом, вы всегда сможете вернуться к определенной версии проекта или просмотреть историю изменений.
Для того чтобы управлять изменениями в проекте, рекомендуется использовать ветки. Ветки позволяют разрабатывать новые функции независимо друг от друга, а затем объединять изменения в основную ветку.
Кроме того, для более удобного отслеживания изменений и совместной работы над проектом, можно использовать онлайн-платформы для хостинга репозиториев, такие как GitHub, Bitbucket или GitLab. Здесь вы сможете делиться кодом с другими участниками команды, отслеживать изменения, создавать задачи и многое другое.
Таким образом, использование системы управления версиями, такой как Git, позволит вам эффективно вести базу знаний всех обновлений, исправлений и изменений в вашем проекте.