Рубрика «Подготовка технической документации»

Богатый язык инженера - это ещё один способ утвердить свой профессиональный уровень в глазах окружающих.

- Ооо, ты инженер конструктор?

          - Да!

- Скажи что-нибудь как инженер конструктор!

        -Крыльчатка насоса.

- Бог с ним, отправляй, по замечаниям исправим...

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

«Мистер X» или стоит ли небольшой команде рассмотреть XWiki как возможную замену Confluence? - 1

Если я всё правильно понимаю, в феврале 2021 года Atlasian прекратил продажу серверной версии Confluence.

On February 2, 2021 Pacific Time (PT), the following changes will go into effect:

- End of new server license sales: You can no longer purchase or request a quote for a new server product.

- Updates to server prices: We will implement new prices for server renewals and upgrades.

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

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

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

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

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


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