СФ
если это только HTML, то степеней свободы у вас становится куда как больше
Size: a a a
2019 June 26
V
увы нет, html, word, pdf
V
но тут я думаю мы сможем применить pandoc
СФ
сложнее всего дается конвертация в DOCX
VB
раз такая пьянка.. расскажите про волшебную пилюлю.
Есть доки в основном в word во что лучше сейчас смотреть, что бы в последсвии сделать нормальную документацию на ПО. направьте, пинком в зад, в какие инструменты копать.
Сейчас видится, что всё перевести в MD или rST с нарезкой по главам, а дальше все собирать в единый документ, ну и на выходе в pandoc для разных форматов..
Есть доки в основном в word во что лучше сейчас смотреть, что бы в последсвии сделать нормальную документацию на ПО. направьте, пинком в зад, в какие инструменты копать.
Сейчас видится, что всё перевести в MD или rST с нарезкой по главам, а дальше все собирать в единый документ, ну и на выходе в pandoc для разных форматов..
посмотрите в строну http://www.writage.com/
VB
но у меня были проблемы с ним - большие файлы он через раз конвертит в md
V
ох какая штука, посмотрю обязательно
V
у нас конечно не прокатит, надо будет думать что то с таблицами сложными
K
его как раз смотрим.
t.me/foliantdocs — присоединяйтесь!
A
на ум приходит такое: держать plantuml в отдельных файлах *.puml, инклюдить их в asciidoc
Эх... Возненавидел маркдаун ещё больше))
НН
Эх... Возненавидел маркдаун ещё больше))
но тут же про аскидок
NV
Эх... Возненавидел маркдаун ещё больше))
В нём тоже есть инклюды. Вот в Foliant, например )
A
но тут же про аскидок
я ж как раз про это, что аскидок тащит
НН
я ж как раз про это, что аскидок тащит
Мне маркдаун тащит :}
НН
А вариаций инклюдов для md — куча
A
В нём тоже есть инклюды. Вот в Foliant, например )
очередной flavor)
NV
Ну да, это печальная судьба Markdown. Куча диалектов.
AL
Для markdown, docx и ГОСТа есть еще вот такое извращение: https://gitlab.iaaras.ru/iaaras/gostdown на Powershell и pandoc/latex. Я немножко попользовала, для небольшого проекта работало сносно.
2019 June 27
NK
Курс по документированию REST API на русском языке.
Тут случилось что-то невероятное. Курс Тома Джонсона по документированию REST API переведён на русский язык. Денис Старков сделал это сам, один, за полгода работы.
Оригинальный Documenting APIs: A guide for technical writers and engineers — наверное, самый полный и полезный открытый курс по документированию. Он рассчитан на технических писателей, разработчиков и студентов. Для техписателей этот курс — точка входа в документирование кода и API, очень интересную область работы, за которую ещё и неплохо платят. Разработчики из этого курса научатся структурировать информацию и понятно описывать свой код и API.
Читайте переведённый курс по документированию REST API, рекомендуйте его коллегам, ставьте звёзды репозиторию. Шлите пуллреквесты с правками, наконец. :)
Тут случилось что-то невероятное. Курс Тома Джонсона по документированию REST API переведён на русский язык. Денис Старков сделал это сам, один, за полгода работы.
Оригинальный Documenting APIs: A guide for technical writers and engineers — наверное, самый полный и полезный открытый курс по документированию. Он рассчитан на технических писателей, разработчиков и студентов. Для техписателей этот курс — точка входа в документирование кода и API, очень интересную область работы, за которую ещё и неплохо платят. Разработчики из этого курса научатся структурировать информацию и понятно описывать свой код и API.
Читайте переведённый курс по документированию REST API, рекомендуйте его коллегам, ставьте звёзды репозиторию. Шлите пуллреквесты с правками, наконец. :)
NV
Добрый день всем. Засорять чатик кучей вопросов не хочется, поэтому спрошу так - нет ли у вас какой-нибудь краткой выжимки по инструментам документирования для айти-компании? Так, чтобы прочитал и понял в каком направлении двигаться.
Исходные данные - ранее в компании документация не велась. Какими инструментами задокументировать код, разработчики примерно представляют. Остается вопрос о документации разных бизнес-процессов, чек-листов, инфраструтктуры и прочего.
Исходные данные - ранее в компании документация не велась. Какими инструментами задокументировать код, разработчики примерно представляют. Остается вопрос о документации разных бизнес-процессов, чек-листов, инфраструтктуры и прочего.
Вот этот курс отлично рассказывает про документирование кода и API: https://t.me/docops/333