Комментарии 9
С интересом бы почитал про интеграцию кастомных html элементов с pdf. У antora есть плагин который умеет собирать странички в один документ, однако проблема разбежки UI в html и pdf у всех пользователей в полный рост, без какого либо масштабируемого решения. Сам живу с ifdef'ами и прочими стилевыми компромиссами.
Спасибо за статью!
Хорошо вас понимаю.Мы в данный момент работаем над решением этой проблемы, но я все больше склоняюсь к созданию нашего собственного механизма экспорта в PDF из Antora. Планируем сделать его открытым и поделиться с сообществом, разместив в Open Source. Как только решение будет готово, это станет хорошим поводом для написания очередной статьи о нашем опыте в этом направлении и мы обязательно о нём расскажем.Спасибо за ваш отзыв!
Интересно, как вы планируете спринты? Задачи сразу назначаются исполнителям или есть общий пул задач, откуда все берут?
Из описания получается, что все задачи выполняются за один спринт. А что, если есть открытые вопросы или техническая проверка запоздала?
Насколько вообще обязательна техническая проверка? Для 100% задач или для избранных?
1) Мы упоминали два источника для всех статей: из составленных на продолжительный срок вперёд content maps и постановки из смежных отделов на новый функционал. Все задачи извне поступают только на Head of TW, затем на автора.
2) Все задачи попадают на тест за один спринт. Техническая проверка проводится позднее и, в случае правок, учитывается в следующем спринте.
3) Техническая проверка у нас обязательна для всех статей.
В рабочем процессе отдельно выделили проверку на опечатки, грамматические ошибки. Это всегда ручная проверка или вы дополнительно используете какие-то автоматические проверки/линтеры?
Подскажите, а когда у вас появится для ADB список SQL команд? Пока есть только ссылка на документацию VMware в загадочном разделе «список команд SQL, не поддерживаемых в ADB».
Денис, поскольку мы знакомы лично, буду на "ты". Для ответов на подобные вопросы предусмотрен совсем не загадочный раздел "Релизы документации", о котором упоминалось в нашей публикации. Просто используй фильтр по продукту ADB и следи за обновлениями. За последние 2 года было выпущено 120+ релизов документации по всем продуктам, так что долго томиться в ожидании тебе явно не придётся, хотя, признаюсь, у меня нет убежденности в том, что именно это являлось целью твоего вопроса. Тем не менее, спасибо за интерес к статье!
Дима, я действительно хочу подсветить проблему. Просто вспомни, что произошло с конверсией сайта документации PostgresPro, когда они завершили перевод PostgreSQL - им никакой СЕО не нужен после этого. Ну и став первыми с русской документацией вы автоматически становитесь стандартом и определяете терминологическую базу во всей русскоговорящей среде. Да, кстати, если будете делать, я рекомендую посмотреть на пример SQLite с их railroad диаграммами синтаксиса.
P.S. Будь менее токсичным, пожалуйста.
Денис, позволю себе не согласиться ни с твоей позицией, ни с твоим определением "токсичности". Мне кажется будет полезным, если ты это определение постарашься рассмотреть сквозь призму себя самого. Прошу тебя придерживаться уважительного тона в общении. Тем не менее, спасибо за твой внимательный и даже несколько навязчивый трепет за судьбу документации в Arenadata, в которой ты когда-то работал. Мы непременно рассмотрим твои рекомендации.
Просто поразительно. Я пришел прочитать статью по ссылке из телеги и украсть пару идей для нашей документации. Прошелся по ссылкам, не нашел команд (а мне хотелось посмотреть, как это сделано у вас), подсветил проблему, которой уже года четыре как минимум. В результате получил порцию токсичности от тебя на ровном месте. В общем, так себе опыт.
Разработка документации в продуктовой IT-компании с нуля