Рубрика «docsascode»

Меня зовут Саша, я технический писатель в команде документации Yandex Cloud. В свободное от работы время я занимаюсь другой работой — изучаю инструменты для документирования и экспериментирую с ними. Один из моих экспериментов был посвящен изучению и внедрению спеллчекера CSpell в мои процессы создания документации.

Статья будет полезна всем, кто хочет научиться проверять тексты в исходных файлах, будь то Markdown, YAML или комментарии в коде. Больше всего пользы из нее вынесут технические писатели и те, кто формирует процессы для команд технических писателей.

Читать полностью »

Docs as Code. Часть 1: автоматизируем обновление - 1

В больших проектах, состоящих из десятков и сотен взаимодействующих сервисов, всё чаще становится обязательным подход к документации как к коду — docs as code.

Я покажу, как можно применять эту философию в реалиях classified-сервиса, а точнее, начну с первого этапа её внедрения: автоматизации обновления данных в документации.

Читать полностью »


https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js