Концептограмма – как метод повышения эффективности технической документации

Аналитик Группы «Иннотех» Константин Котельник задумался о том, как упростить разработчикам восприятия технической документации, а также помочь новому поколению с клиповым мышлением эффективно работать с большими объёмами информации. О возможности появ…

Как описать большую систему в нотации С4

Хабр, привет! Нас зовут Дмитрий Фролов и Владимир Мясников.Мы стандартизировали подход по документированию внутренних систем в команде интеграционного тестирования Мир Plat.Form с помощью «Модели С4». Платежная платформа «Мир» представляет из себя д…

Как описать большую систему в нотации С4

Хабр, привет! Нас зовут Дмитрий Фролов и Владимир Мясников.Мы стандартизировали подход по документированию внутренних систем в команде интеграционного тестирования Мир Plat.Form с помощью «Модели С4». Платежная платформа «Мир» представляет из себя д…

[Перевод] Чему можно научиться благодаря возникновению инцидентов

В прошлом году часть нашей команды, которая обеспечивает безопасность платформы Spotify for Artists (S4A), провела исследование ряда инцидентов, произошедших с S4A в 2021 году. Мы выдвинули несколько гипотез, а затем приступили к анализу каждой из них …

Как документировать сервер и контролировать его управление, даже если у вас небольшой стартап

Привет, Хабр! Меня зовут Даниил Воложинок, я инженер в группе виртуализации. Представьте себе ситуацию. У вас есть сервер с комплексом приложений и настроек, который несколько лет обслуживает админ — ”золотые руки”. Однажды “золотой” админ увольняется …

[recovery mode] Бессмертный код. Манифест ALPHA

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

Можно ли избавиться от технических писателей

Согласитесь, что название статьи звучит немного странно. Зачем же избавляться от этих милых, слегка занудных, но в основном весьма безобидных людей?Как их только не называют: техписы, техрайтеры, документаторы… Хорошо, хоть не архивариусы!Если мы изб…

Docs-as-code: DevOps-технологии в документировании, или Как подружить технического писателя и разработчика

Привет, Хабр! Меня зовут Роман Блинов, я ведущий технический писатель в «Цифре» — в команде по развитию платформы ZIIoT. Этот пост будет о подходе Docs-as-code для документирования разработки ПО. Пишу с прицелом на тех читателей (то есть писателей), кт…

Хороший, плохой, злой комментарий

Зачем нужны комментарии. Правда ли, что хороший код должен быть без них и как команды замедляют разработку в 4 раза, забывая о «смысле жизни». Читать далее…

О роли системного аналитика и шаблон для проектирования

Сейчас нужно написать краткое введение о том, что важно проводить аналитику для задачи на разработку: оценить влияние изменений, проработать все возможные сценарии и т.д.Понимание сути и объема задачи должно появиться до первой строки кода. Писать скол…