Continous Documentation

Slide 1

Slide 1 text

Никита Соболев github.com/sobolevn

Slide 2

Slide 2 text

Continous Documentation Repeatable Software Development Process

Slide 3

Slide 3 text

Repeatable Software Development Process • Платим только за закрытые задачи • Маленькие задачи, по одной за раз • Код, трекер и документация - больше ничего https://wemake.services/meta

Slide 4

Slide 4 text

Мы говорим только про внутреннюю техническую документацию

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

Почему программисты не любят писать документацию? • Им за нее не платят • Они могут черпать знания в других источниках • Они и так все знают

Slide 7

Slide 7 text

Они и так все знают • Работают над одной частью системы • Копят знания • Не делятся ими

Slide 8

Slide 8 text

Наше решение Распределять задачи случайным образом

Slide 9

Slide 9 text

Другие источники • Написал в телеге • Подошел - спросил • Где-то в почте было

Slide 10

Slide 10 text

Наше решение Запретить общаться неформально

Slide 11

Slide 11 text

Мне за ... не платят

Slide 12

Slide 12 text

Наше решение Платить!

Slide 13

Slide 13 text

No content

Slide 14

Slide 14 text

No content

Slide 15

Slide 15 text

Проверяй, что пишешь! swagger-conformance doc8 swagger-spec-validator flex jsdoc remark-lint eslint-plugin-jsdoc eslint-config-jsdoc-essential flake8-docstrings sphinx mypy flow

Slide 16

Slide 16 text

Hot start • https://github.com/wemake-services/ wemake-vue-template • https://github.com/wemake-services/ wemake-django-template

Slide 17

Slide 17 text

Проблемы • Попробуй продай! • "У вас такое никогда не будет работать" • Взаимодействие с другими командами

Slide 18

Slide 18 text

Вопросы? github.com/sobolevn [email protected]