Пост о том, как я разбирался с Diplodoc
Пост о том, как я разбирался с Diplodoc.
Это платформа для создания технической документации в концепции Docs as Сode с открытым исходным кодом.
Разбирался и продолжаю разбираться как в личных целях, так и для MarketDB, так как нынешняя документация откровенно не очень.
Узнал об этом сервисе на (Не)Конференции от Яндекса, где директор платформы Diplodoc презентовал возможности продукта. Кстати, все доки Яндекса написаны с помощью этого сервиса.
Так вот, лектор рассказывал, как просто, легко и удобно у них делать доку, что они придерживаются популярных принципов построения кода: KISS, DRY и т.д.
Только есть забавный момент. У разработчиков сервиса для легкого написания документации местами не очень понятная или неполноценная документация, такая вот боль, ирония и правда.
Не буду нагнетать, в целом все нормально, уверен разобраться можно. Документация Yandex.Cloud выглядит супер приятно и все это с помощью сервиса Diplodoc. Дополнительно стоит овладеть знаниями CSS и, возможно, JS, хотя, как утверждают разработчики сервиса, обойтись можно и без этих знаний.
А пока что можете посмотреть, что у меня получается: https://github.com/TrueDranik/diplodoc-example.
(То, что на скрине почему-то не работает, как должно, хотя написано согласно документации)
Немыкин.Продакшн
#Diplodoc #Документация #Разработка
