Документация как код
От: rosencrantz США  
Дата: 18.09.20 23:06
Оценка:
Есть ли в природе инструменты для работы с документацией как с кодом?

Примеры хотелок:

1. Извлечь из документа кусок в отдельный документ и в исходном документе вставить ссылку на новый документ.
2. Статистические проверки типа не меньше 100 и не больше 1000 слов на документ.
3. Вместо текста "Импорт юзеров из CSV" ставить тег типа "@users-from-csv-import", а оно чтобы само подставляло название фичи и ссылку на её описание. Потом если фичу переименовываешь, чтобы оно во всех документах само переименовало.
4. Описать "шаблоны" для повторяющихся тем, и вместо текста в свободной форме писать какой-нибудь YAML-образный документ с заранее определёнными обязательными полями ("название фичи", "короткое описание фичи", "длинное описание фичи")
5. Чтобы на выходе получалось что-то типа вики — не всё в одну кучу, а много связанных страничек.

Ищу не обязательно сразу всё в одном инструменте, но интересно если что-то из этого существует.
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.