Size: a a a

DocOps-сообщество

2019 October 17

ИЦ

Игорь Цупко in DocOps-сообщество
источник

RG

Ramil G in DocOps-сообщество
Для asciidoc есть https://asciidocfx.com но тоже на яве. Не умеет подсветку комментариев и нет   Встроенной Поддержки git.
источник
2019 October 18

вк

волад коваль in DocOps-сообщество
Для *.md супер! - куча плагинов проверки синтаксива, орфографии, предпросмотра и т.д.
источник

RG

Ramil G in DocOps-сообщество
Похоже придётся остановиться на маркдауне
источник

НН

Нац Нац in DocOps-сообщество
волад коваль
Для *.md супер! - куча плагинов проверки синтаксива, орфографии, предпросмотра и т.д.
Именно, пиарю кому могу )
источник

NK

ID:0 in DocOps-сообщество
Опубликованы записи докладов и слайды недавней конференции API the Docs: https://pronovix.com/event/api-docs-amsterdam-2019.
Там всё про документирование кода и API.

Спасибо @aselivanava за ссылку :)
источник

FM

Fox Mulder in DocOps-сообщество
Всех с тяпницей. Глупый вопрос. Есть в google docs нечто типа маяков для сокращений и прочего и дальнейшего автосбора этого хозяства?
источник

НН

Нац Нац in DocOps-сообщество
Сноски? Или чо
источник

FM

Fox Mulder in DocOps-сообщество
нет. Например, в dita ты сокращение можешь обернуть тегом и дальше через функцию произвести коллекционирование всех таких маячков
источник

НН

Нац Нац in DocOps-сообщество
Оу, сложно, наверное нет
источник

FM

Fox Mulder in DocOps-сообщество
Печально. Сяп.
источник

НН

Нац Нац in DocOps-сообщество
Пробегись по плагинам, мож чот есть, ю Невер ноу
источник
2019 October 19

AK

Artem Krosheninnikov in DocOps-сообщество
Семён Факторович
но вообще хочется надеяться, что парсить, раскрашивать и держать в памяти DOM маркдаун-документа должно быть полегче, чем миллиона строк в джава-проекте
В одном из последних EAp'ов анонсировали ускоренную загрузку проекта, реально работает. К самой работе не относится, но всё же. И с переходом самой идеи на использование JBR 11 улучшило ситуацию с использованием памяти (вот тут пруф уже не найду)
источник

AK

Artem Krosheninnikov in DocOps-сообщество
Вопрос по теме чата: есть xwiki, куда мы пишем статьи. Хочется сами статьи хранить в маркдауне или чем-нибудь ещё (в отдельной репе, соответственно), и потом легко их публиковать в xwiki. Наверняка есть уже велосипед, просто я не так искал? Тут ещё подвох в том, что если на самой Вики указать формат маркдауна, то всё может неожиданно расползаться во все стороны, а в стандартном формате для xwiki всё пучком.
источник
2019 October 20

NV

Nick Volynkin in DocOps-сообщество
Artem Krosheninnikov
Вопрос по теме чата: есть xwiki, куда мы пишем статьи. Хочется сами статьи хранить в маркдауне или чем-нибудь ещё (в отдельной репе, соответственно), и потом легко их публиковать в xwiki. Наверняка есть уже велосипед, просто я не так искал? Тут ещё подвох в том, что если на самой Вики указать формат маркдауна, то всё может неожиданно расползаться во все стороны, а в стандартном формате для xwiki всё пучком.
Если хранить и редактировать в md,  какие фичи останутся от xwiki? Нужно ли редактировать прямо в ней?
источник

JM

Jaroslaw Martinow in DocOps-сообщество
Nick Volynkin
DocOps-митап начинается с доклада о том, как вести репозиторий с документацией. Рассказывает Константин Валеев, сотрудник Ростелекома и один из авторов Foliant.
Константин тут мегапонятно рассказывает про ветвление в Git!! В короткой презентации прям всё!! Я кайфанул. Спасибо!! 🤤
источник

JM

Jaroslaw Martinow in DocOps-сообщество
Sergey Bronnikov
https://twitter.com/patio11/status/1184277080898338816  ""People should just read their man pages."

If you like your man pages you can keep your man pages, but there are a few million people operating systems professionally who ask their questions to Google because Google has a reputation for providing actual answers quickly.". Если пользователи ищут ответы не напрямую в документации, а в Гугле это ведь не значит, что документация плохая. Но иногда бывает, что документация действительно не полная и не покрывает какие-то сценарии, которые описаны в блогах или stackoverflow. Улучшаете ли вы документацию когда видите популярные вопросы для вашего ПО на stackoverflow или например вопрос который в google suggest появляется?
Я ищу ответы в Гугле, а не в доках, потому что блоггер чаще всего напишет коротко и простым человеческим языком так, как проще всего ответить на вопрос. Плюс, в поисковой выдаче мне вылезет 10 ответов на мой вопрос, и я смогу сравнить разные видения разных людей и выбрать самый подходящий мне ответ
источник

AY

Andrei Yemelianov in DocOps-сообщество
Доступен сборщик документации PzdcDoc 1.7 https://opennet.ru/51715/
источник

AY

Andrei Yemelianov in DocOps-сообщество
Название-то какое!
источник

НН

Нац Нац in DocOps-сообщество
PzdcDoc for Pidora
источник