Как мне написать справочную страницу?
Где я могу найти ссылку на все коды форматирования?
Есть ли хорошие учебники по написанию страниц руководства?
Как наиболее удобно написать страницу руководства? Должен ли я вводить его прямо в текстовом редакторе? Есть ли редакторы WYSIWYG? Или мне написать его в другом формате и потом конвертировать?
Каким правилам должна следовать хорошая страница руководства?
Вот несколько веб-страниц, которые помогут вам начать работу:
Пара полезных инструментов:
Существуют инструменты для написания страниц руководства, которые обходят форматирование troff. manpages - это небольшой язык с четкими разделами, на который легко настроить таргетинг.
Два популярных инструмента:
йодль и зоэм кажется, есть другие хорошие форматы в этом пространстве.
В общем, я бы порекомендовал xmltoman, потому что это dsl, очень специфичный для man-страницы, который поможет вам подробно.
Я написал довольно обширную статью в блоге по этой теме, которую вы можете найти здесь:
Я не знаю никаких IDE или руководств, но вы можете начать с копирования существующей справочной страницы и изменить ее в соответствии со своими потребностями.
Для справки по языку groff с макросами MAN (которые используются на странице руководства) обратитесь к groff_man страница руководства или Прочтите это онлайн здесь
Взгляните на ронн проект. Это уценка к генератору страниц руководства. Он также может создавать справочные страницы в html, например этот.
Мне нравится идея писать всю документацию по программному обеспечению в одном формате. Markdown IMO - хороший выбор