plan.md

Документация как код

Главная мысль:

Документация как код - это подход который имеет свои преимущества и может быть полезен многим

План

• Опрос: чем пользуетесь

  • notion
  • google docs
  • confluence
  • docs as a code
  • other

  Кто слышал о docs as a code? А кто пробовал?

• Сегодня мы поговорим о подходе docs as code, о его плюсах, минусах и реализации.

• Что такое docs as code, основные принципы

• Проблематика?

• Кейсы?

• Кому подойдет

• Вывод: docs as code хорошо зайдет если

Преимущества

• вы доросли до ревью требований

• вы понимаете значимость удобства редакторов кода

• вам нужна open source self hosted система или мало денег

• вы сидели на google docs и хотите получить инструмент следующего уровня

• вам нужна отчуждаемая система документации

• вас не пугает работа с git

• вам не нужна сложная система прав или вы готовы допилить ее

Фичи

• Визуализация Gerkin (StoryMapper)
• mermaid