База знаний: от свалки до системы (подборка)

Проблема многих больших и взрослых продуктов, что база знаний живёт своей жизнью. Слои недописанных статей, схемы, которые никто не обновлял с момента перехода на «единую архитектуру» 2018 года, а единственный актуальный документ висит в личке у коллеги, который в отпуске, а после отпуска увольняется 😉

Бывало, что приходя на новую задачу, получаете на входе кучу огромных неактуальных схем и агрессивные сроки новых доработок?

Собрала подборку статей о базах знаний. Здесь о том, как восстанавливать базы знаний с нуля, что и как документировать, и как приводить в чувство то, что уже разрослось, как сорняк.

🔖Генеральная уборка базы знаний: плюсы, подводные камни, минусов не будет
Эта статья от технического писателя и посвящена пользовательской базе знаний - одним из инструментов тех.поддержки. Но есть вещи, которые можно перенять и для работы с документацией архитектуры и требований, если вам вдруг достался большой объем чего-то неактуального. Построение процесса, организация структуры и регулярная актуализация.

👁‍🗨Аналитик и legacy: как разобраться в устройстве старой системы? Запись доклада Максима Цепкова, где он рассказал как можно разобраться в устройстве системы и вписать изменения в бизнес-архитектуру, если нет актуальной документации. Моя любимый тезис из этого доклада: если выглядит так, что заказчик говорит ерунду и путается, то наверняка это вы в чем-то пока еще не разобрались.

🔖Что делать, когда попал на проект без документации? На примере приложения для магазина игрушек пошагово и с примерами разобран процесс восстановления документации в смешанной роли БА/СА. В заключении статьи прозвучал важный вопрос "Давайте оглянемся назад и честно ответим, кому нужен был данный марафон с восстановлением документации?"

📎Мало слов и много смысла
Обзор доклада "Как писать, чтобы покороче, но со всеми важными деталями" Сергея Нужненко на WAW прошлого года. Здесь о о том, что документировать, а что не обязательно и еще список книг для работы с текстом.

🗞Как мы случайно сделали Semantic Wiki в Gramax Статья в блоге компании Gramax о базе знаний, которая не просто хранит контент, но и организует связи между ее объктами. Здесь речь о конкретном продукте компании, но можно и просто подсмотреть подход.

🖇Шаблоны требований Пост в этом канале об использовании шаблонов документов. Разбираюсь, почему чужая шпаргалка не работает так же хорошо, как своя, и делюсь подборкой примеров.

#что_почитать