Если подводите итоги года и размышляете, что можно улучшить в 2023, присмотритесь к внутренней системе знаний. Точно ли документация по продуктам и процессам обновляется вовремя? Понятно ли оформлена? А как насчет навигации — можно ли найти нужное в пару кликов?
Выпустили в блоге Selectel полезный гайд, в котором рассказываем, как систематизировать и оформить техническую документацию с помощью макросов.
В тексте поговорим о том:
почему Confluence ругают за неповоротливость и почему часто это делают зря,
зачем нужны макросы и как ими пользоваться,
как лучше оформлять подсказки и примечания для команд, код, ссылки на внутренний и внешний контент.
бонус-блок
бонус-блок
Скриншоты с примерами оформления документации и полезные ссылки на случай, если «базовой комплектации» будет недостаточно.
