help-gen v1.0.12

help-gen

Генерация и предпросмотра файлов справки

Порядок создания справки. Допустим нужно откорректировать справку для портала zk. Для этого надо :

созать файл справки help-zk.docx импортировать эти стили из help-vs.docx в help-zk.docx применить стили в help-zk.docx к соответствующим фрагментам текста проверить с помощью утилиты help-gen, что получается html справка с корректно применёнными стилями передать программисту файл help-zk.docx программист генерит справку в папку static/files/help/help-zk проекта 2zui Пункты 1-5 выполняет автор справки, то есть участник формирующий содержание справки.

Утилита help-gen устанавливается так: $ npm i -g help-gen

Автор справки использует help-gen так: help-gen -d help-zk.docx

Программист использует help-gen так: help-gen -d help-zk.docx -t ../../static/files/help/help-zk -p zk