rails
January 27, 2021

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

Начал большую эпопею с обновлением генерации документации...
Смотрю на middleman и конкурентов пока не вижу.

Чтоб всё взлетело надо проработать ряд моментов:

  • бизнес документация - это что пишется редко и руками
  • техническая документация - это что использует автогенерацию (снипеты и примеры из репозитория, языки разметки типа yard, rdoc и ко)
  • статические файлы - примеры, PDF, zip
  • сбор доки из нескольких репозиториев
  • MindMap со структурой документации - что вообще хотим видеть, какие разделы и как именно отображать?
  • SEO - всякие там sitemap, permalink, rss
  • Метрики - yandex metrics и google analytycs
  • Ну и стиль/шаблон/тема

Погнали!