Как вести базу знаний всех обновлений, исправлений и изменений, вносимых в проект?

Question

[nop71]

Есть проект, в нем есть разные механизмы. Я хочу вести какую-нибудь базу знаний, в которую буду делать записи обо всех нововведениях, вносимых в проект. Главное: нужна какая-нибудь система "тегов", чтобы можно было для записи об обновлении указать в "теге" конкретный механизм, который это обновление затрагивает. И в будущем, если мне нужно будет просмотреть все обновления, связанные с каким-то конкретным механизмом, я бы искал по этим "тегам".

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

Comments

[Лариса .•º]

Вопрос по git репозиторий ( кодовую базу) или бизнес логику приложения ?

[nop71]

Лариса .•º, Про бизнес-логику

[Luka83]

А "проект" и "механизмы" в каком формате сейчас описаны?

Answer 1

[GavriKos]

Звучит как обычный таск-трекер. Если таски правильно сформулированы и оформлены - то все там можно будет найти.

Answer 2

[Saboteur]

1. commit message
2. task tracker (JIRA или аналоги)

Если их интегрировать друг с другом, будет еще и довольно просто перемещаться по коммитам

Answer 3

[dmitriy]

1. Формировать задачи в трекере, например gitlab
2. Использовать релизы
3. С выходом релиза фиксировать задачи/фикс багов, релиза в CHANGELOG.md

Answer 4

[hrkatewest]

Рекомандую изучить ХайХаб (https://start.hihub.ru/):
- бесплатная база знаний с лимитов в 5 сотрудников (для небольших команд до 50 человек всего 4900 в месяц)
- древовидная система папок
- конечно есть теги
А еще плюсом станет расширенный поиск, по ключу изущется даже по прикрепленным документам. Есть поддержка языка разметки Markdown и конечно режим публикации кода.

Answer 5

[Артем Воронов]

решал подобные задачи связкой TeamCity + Jira + Confluence: При деплое на Prod TeamCity подтягивала список заплоенных stories из GIT. Далее небольшой скрипт формировал страницу в Confluence, подтягивая детали stories из Jira. Завершалось это все сообщение в Slack c ссылкой на полученную страницу.
Это требует договоренностей с командой разработки, например, user story Id должно присутствовать в описани коммита.

Answer 6

[mayton2019]

Можно в git коммитах писать комментарии с тегом. И задача хранения уже будет решена.
Задача поиска - это тоже интересный вопрос. Ну как вариант можно список коммитов раз
в сутки сливать в текстовый отчет и индексировать через ElasticSearch.

Answer 7

[Vitsliputsli]

Confluence, обычно в нем ведут базу знаний, также там есть теги - labels.