Пожалуйста, обратите внимание, что я не прошу конкретный c продукт или конкретный c инструмент. Сказав это, оцените помощь, чтобы сделать вопрос более цель.
Сегодня у нас есть, как мне кажется, очень медленный, трудоемкий и неэффективный способ создания технических документов, таких как руководство пользователя, руководство для разработчиков, руководство по установке, обзорное руководство, функциональные спецификации. Между инжинирингом и функцией управления продуктом мы внутренне поддерживаем документы Word, полные форматирования, технических диаграмм, снимков экрана и т. Д. c. Они обновляются и передаются группе технической документации, которая использует DITA и создает файлы PDF. Файлы PDF передаются обратно, а комментарии к комментариям добавляются в PDF в виде комментариев, которые затем включаются группой документации через серию итераций. Команда документации гарантирует, что форматирование, внешний вид, структура, брендинг являются согласованными.
Однако я хотел бы, чтобы мы перешли к более легкому, более оптимизированному, более быстрому процессу (для создания / обновления / просмотра контента), и это может привести к выбору сгенерированной документации, по-прежнему со всеми диаграммами. , скриншоты, форматирование, брендинг как HTML и PDF. По крайней мере, с документацией HTML я бы хотел, чтобы наша документация также имела перекрестные ссылки, чтобы читатель мог легко просматривать документацию.
Мы бы предпочли использовать процесс и рабочий процесс, которые идут хорошо с помощью модели разработки Agile можно также рассматривать документацию как код (номер версии), но более всего - быстрее просматривать и обновлять содержимое. Мы уже рассмотрели AsciiDo c, Markdown, reStructured Text, Creole и LateX.
Так каковы относительные достоинства и недостатки этих инструментов (или любых других) для нужд, описанных выше? В какой степени можно автоматизировать создание окончательной документации (с помощью диаграмм, форматирования, брендинга и в 2 формах, например, PDF и HTML)? Могут ли все они действительно эффективно работать в Agile рабочем процессе?