DocOps

А это тот же баннер на artlebedev.ru

Минутка UX-писательства. Вот это баннер про куки на culture.ru

Официальная позиция Программных комитетов Highload++ и других IT-конференций на претензии к Игорю Сысоеву. Там и моя подпись есть.

Пара отличных докладов с последнего Гипéрбатона (это такая конфа Яндекса про документацию).

Агрессивный наброс на документацию и вполне адекватный ответ. https://github.com/valor-software/ngx-bootstrap/issues/5566

Привет! TLDR Пару месяцев назад я решала проблему — чем генерить документацию в PDF, если у тебя доку собирает MkDocs, который из коробки этого не умеет. Просила тут помощи и обещала здесь же отписаться, что пробовала, к какому решению пришла. Я начинающий автоматизатор, могу написать простенький скрипт на баше или питоне, не больше. В сторону генерации из HTML я сразу не пошла, так как там не одностраничный документ и CSS для меня это слишком сложно. Поэтому я смотрела конвертеры из Markdown в PDF. Что я пробовала: 1. Конвертер https://hub.docker.com/r/fiware/md2pdf/. Мне с разбега даже hello world не дался, нужно разбираться в настройках. Если бы не помог @glu0n, я бы может и не справилась. Результат очень не очень внешне + не работает с кириллицей из коробки. Зато не нужно собирать всё в один файл, он это делает за вас, ему можно скормить тот же конфиг что уже есть в MkDocs. 2. Typora https://typora.io/. Самое простое и быстрое решение. Делает все через Pandoc, очень хорошо настроен шаблон, PDF получается эстетичный, правильно подсвечивает код. Можно скачать десктопное приложение. Cобственно я так и сделала, когда мне нужно было сделать PDF быстро. Минусы: все равно кое-чего не хватает например, в готовом PDF нет номеров страниц, нужно как-то собирать все md-файлы в один, ну и герерить придется руками (зато GUI). 3. Foliant https://github.com/foliant-docs. Самый серьезный инструмент, делает всё, что нужно. Тоже генерит через Pandoc. Тоже не нужно собирать ему один файл. Разобраться самостоятельно можно, есть документация, хотя мне все-таки потребовалась помощь создателей, но они слава богу отвечают в чате. Из коробки PDF у меня получился достаточно приличного качества. Но стало понятно, что если я хочу что-то поправить, то нужно будет самой настраивать шаблон, плюс Foliant по-моему нет смысла использовать только для сборки PDF, он не использует ваш конфиг MkDocs, использует свой конфиг с содержанием (foliant.yml). По-хорошему нужно делать сборку всех форматов доки Фолиантом. 4. Pandoc. Полный контроль над процессом, но настройка, самое сложное — LaTeX-шаблон. Ну и собирать все md-файлы в один тоже придется. Килограммы документации, и она неплохая. Как я генерирую PDF в итоге: Стало понятно что все равно придется настраивать LaTeX-шаблон. И надо склеить md-файлы в один. Так как я контрол-фрик, да и сборка html-документации в MkDocs у меня уже настроена, я не стала склеивать файлы сторонней тулзой. Я написала короткий Python-скрипт, который парсит YAML-конфиг MkDocs и собирает один md-файл. Этот один я скармливаю Pandoc. Использую --pdf-engine=xelatex. Обложку с названием документа дизайнер сделал в PDF и я ее приклеиваю в конце с помощью pdfunite. Осталось разобраться в туче параметров tex-шаблонов.

Обсуждали на кухне доклад Александра Тоболя про UDP. Когда-то я конспектировал этот доклад с постоянными паузами и повторами видео. Александр рассказывает быстро, а плотность информации довольно большая, так что сходу сложно уловить весь смысл. Интересно, сколько успели понять те, кто слушал доклад вживую на конференции. Ничего не напоминает? Это же UDP. В докладе про UDP!

У нас теперь есть свой человек в Лондоне :) https://t.me/shut_up_and_write/120

Известный техписатель из Амазона Том Джонсон сделал крутейшие тесты на квалификацию, а потом разочаровался в них. Follow-up to 4 Technical Writing Tests Post. It's been a while since I've written a post that has received so many negative comments as 4 Technical Writing Tests to Screen Candidates. Although many people did like the tests and found them interesting or fun, quite a few people had more negative reactions. As a result, I'm scrapping the idea of multiple choice tests as a way to filter candidates... Приходите в @docsascode, обсудим.

Когда-нибудь здесь будет канал с нормальными вакансиями для техписателей: @docops_jobs. С описанием задач, технологий и пользы от документации, а не задолбавших всех печенек. Но не сегодня. Как-нибудь доберусь. А пока что подписывайтесь. :)

Как зачем переводить комментарии в примерах кода? Чтобы вот такие вот угарные примеры получались! https://t.me/tech_b0lt_Genona/1130

Привет! Хочу устроить техрайтерский чятик в Беларуси — Write The Docs Минск. Когда наберем достаточно местных, сможем собраться на митап, кофе, другие напитки. Добро пожаловать: https://t.me/wtd_minsk

Если вы в Беларуси и вам интересна документация — присоединяйтесь :)

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

«Как замотивировать наших ребят делиться своим опытом через текст?» — недавно опубликованный совет от Людмилы Сарычевой. Хорошая тема на пересечении редактуры, деврела и управления знаниями. Я там написал коментарий на основе своего опыта в Plesk и коллективной мудрости DevRel-сообщества. Если вам есть что добавить — присоединяйтесь.

Перевод курса по документированию API теперь есть в форме сайта: https://starkovden.github.io.

​​#latex После доклада на GolangConf решил поделиться опытом создания презентации с помощью LaTeX: https://habr.com/ru/post/471352/ Специально для этой статьи я сделал шаблоны для двух предстоящих конференций: https://github.com/schors/hl2019theme https://github.com/schors/sc2019theme Вобщем, рекомендую. Программировать презентацию оказалось занимательно.

Я протормозил с анонсом, конечно. У вас есть ещё пара часов чтобы проголосовать ^. И я тоже поддерживаю Фила Кулина. Думаю, сейчас лучшее, что можно сделать для интернета — хотя бы не дать его сломать. Фил как раз этим и занимается.