All streams
Search
Write a publication
Pull to refresh
14
Алексей Солнцев @lejbread⁠-⁠only

Технический писатель

Send message

Что проще писать — документацию или код?

Level of difficultyEasy
Reading time4 min
Views1.9K

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

Читать далее

Docs as Code. Часть 2: получаем документацию из кода

Reading time10 min
Views14K


Продолжаем рассказывать о применении на практике принципа работы с документацией как с кодом. В этот раз разберём получение спецификации Swagger напрямую из комментариев к коду API. В статье рассматривается роль технического писателя в процессе адаптации команды к использованию нового инструмента, а также приводятся конкретные инструкции по применению swagger-php в реальном проекте.
Читать дальше →

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

Reading time8 min
Views11K


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


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

Читать дальше →

Information

Rating
Does not participate
Location
Москва, Москва и Московская обл., Россия
Date of birth
Registered
Activity

Specialization

Technical Writer
Lead
Git
Python
C++
Markdown