Как стать автором
Обновить

Комментарии 6

Странно. Вроде как налить воды и нагенерировать текст на пару страниц - тут у ботов нет конкурентов. Это давно известно.

Мы так уже второй год используем , чтобы закрыть KPI по написанию рабочих инструкций , которыми все равно никто не пользуется .

Насчет воды вы правы. Жаль, что у вас так настроен процесс документирования. Мне в работе как раз не нужно воды. Нужно кратко, по делу и с пользой для читателя

По поводу кейса №5 - есть же в Linux хорошая утилита "tree", которая прекрасно с этим справляется. Куча опций вывода (XML, JSON, HTML), сортировка и т.д.

Спасибо! Буду знать. Я на винде работаю и живу

А если взять в сравнение документацию на md, почему бы её не использовать, нежели чем Sphinx ? Какие она имеет преимущества в написании документации тут ?

Markdown хорош для простой документации, а Sphinx — для крупных проектов. У Sphinx больше интерфейсных инструментов, кросс-ссылки, расширения. При этом сложнее синтаксис и выше порог входа. Если нужно быстрое описание — хватит Markdown, если строить техдок как систему — лучше Sphinx

Зарегистрируйтесь на Хабре, чтобы оставить комментарий

Публикации

Истории