Задача нашей команды — делать практические материалы для разработчиков, а не документацию по ГОСТам. Поэтому мы фокусировались на том, чтобы подготовить понятную и полную документацию.
Что касается юнитов, наша документация работает на платформе Diplodoc и у нее есть возможность переиспользовать блоки информации через include. Мы иногда ей пользуемся, но в приоритете сохранить простоту внесения правок сообществом.
Выбор платформы был обусловлен тем, что к моменту старта проекта, у нас уже была документация на платформе Diplodoc (REST API), процессы были отлажены и нам хотелось поддержать единый стиль
Да, мы понимаем, что документация устаревает без внимания :)
Поэтому мы следим за обновлениями продукта и сразу обращаемся к разработчикам, чтобы актуализировать материалы. ИИ помогает и здесь — он быстро готовит черновик правок по новому коду, а разработчику остается только проверить. Это экономит много времени.
И конечно, мы очень надеемся на сообщество! Если заметите что-то устаревшее — пишите в ишьюсах или комментариях.
Мы используем платформу Diplodoc.
Спасибо за вопросы!
Задача нашей команды — делать практические материалы для разработчиков, а не документацию по ГОСТам. Поэтому мы фокусировались на том, чтобы подготовить понятную и полную документацию.
Что касается юнитов, наша документация работает на платформе Diplodoc и у нее есть возможность переиспользовать блоки информации через include. Мы иногда ей пользуемся, но в приоритете сохранить простоту внесения правок сообществом.
Выбор платформы был обусловлен тем, что к моменту старта проекта, у нас уже была документация на платформе Diplodoc (REST API), процессы были отлажены и нам хотелось поддержать единый стиль
Да, мы понимаем, что документация устаревает без внимания :)
Поэтому мы следим за обновлениями продукта и сразу обращаемся к разработчикам, чтобы актуализировать материалы. ИИ помогает и здесь — он быстро готовит черновик правок по новому коду, а разработчику остается только проверить. Это экономит много времени.
И конечно, мы очень надеемся на сообщество! Если заметите что-то устаревшее — пишите в ишьюсах или комментариях.