Я хотел бы предоставить IT-инструмент для использования в Windows. Это ISAPI-фильтр, и я хочу описать установку, эксплуатацию и настройку.
В настоящее время это делается в текстовом файле, который довольно полный, но я думаю, что он не очень удобен в использовании. Я думаю, что я хорошо разбираюсь вчтодолжно быть в документации. Я хотел бы получить информацию оКакчасть. Каков наилучший способ предоставления документации администраторам веб-серверов Windows?
.CHM? .PDF? .DOCX? .HTM ?
РЕДАКТИРОВАТЬ: Яимелтекстовый файл, но он становился очень длинным, и в нем были ограниченные возможности для связывания, перекрестных ссылок, индексации и организации. Давайте посмотрим, основной раздел подчеркивается знаками равенства, подраздел подчеркивается тире... и т. д. и т. п. Поэтому я попробовал отформатировать его таким образом, но в итоге файл .txt просто не масштабировался.
Обновлять: Я выбрал SHFB. Вотвыходной HTML-справки. Что вы думаете? пригодно?
решение1
Вот мое мнение:
- Текст ASCII великолепен — я могу его прочитать где угодно.
- HTML — второй по качеству. Я тоже могу прочитать его практически где угодно.
- PDF приемлем, но немного раздражает, так как мне может понадобиться обратиться к нему на сервере, где не установлен PDF-ридер.
- CHM — это головная боль из-за дурацкого управления справкой HTML (спасибо HTML Help control bugs/wunlerabilities!), и это не очень удобный формат для копирования/вставки.
- DOCX просто раздражает - у меня на серверах не установлен "Office", и если мне понадобится обратиться к документации, я точно не буду ее загружать.
решение2
Мне нужно использовать правильно отформатированные текстовые файлы ASCII. Их можно читать с ноутбука, сервера, windows, unix, linux и т. д.
Мне не нужно полагаться на веб-браузер, Adobe Reader, Office или любую другую программу, чтобы узнать, как установить что-то на моем сервере. Это должно быть просто и безболезненно.
По правде говоря... в крайнем случае... я даже мог бы прочитать текстовый файл со своего мобильного телефона, если бы пришлось.
Я уверен, что любой, кто застревал в исправительном учреждении в 3 часа ночи при не самых приятных обстоятельствах (например, вызвали из бара, нет ноутбука и т. д.), согласится со мной. ;-)
Просто мои 2 цента...
решение3
Вам следует проверитьасцидок. Я сделал несколько коротких вещей с его помощью, и вывод получился довольно резким (и настраиваемым, конечно). Простой текст очень удобочитаем по замыслу, и вы можете легко вывести docbook, HTML и PDF. Используя любое количество других конвертеров, вы также можете преобразовать его в другие форматы, например CHM.
Очень универсальный пакет, хотя, поскольку он ориентирован на UNIX, я не знаю, как обстоят дела с поддержкой Windows.
решение4
Я знаю, что вы уже приняли ответ, но я подумал, что порекомендуюсфинкс. Вы пишете документ в reStructuredText, но можете легко сгенерировать HTML-код, который можно искать (маленький JavaScript). /