Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Continous Documentation
Search
Sobolev Nikita
August 22, 2018
Programming
0
65
Continous Documentation
Sobolev Nikita
August 22, 2018
Tweet
Share
More Decks by Sobolev Nikita
See All by Sobolev Nikita
PythoNN – Александр Гончаров
sobolevn
0
32
PythoNN – Андрей Пронин
sobolevn
0
60
PythoNN: Василий Рябов – "Парсинг бинарных данных с помощью ctypes, или пишем на питоне как на Си"
sobolevn
0
160
GitHub Planet - OpenSource
sobolevn
0
200
Polymorphism and Typeclasses
sobolevn
2
100
New GitHub Features
sobolevn
0
38
Problems of static analysis in Python
sobolevn
0
95
Announcing typed-linter
sobolevn
0
190
About GitHub Stars
sobolevn
0
160
Other Decks in Programming
See All in Programming
Outline View in SwiftUI
1024jp
1
250
Importmapを使ったJavaScriptの 読み込みとブラウザアドオンの影響
swamp09
4
1.3k
CSC509 Lecture 09
javiergs
PRO
0
130
Dev ContainersとGitHub Codespacesの素敵な関係
ymd65536
1
140
AWS IaCの注目アップデート 2024年10月版
konokenj
3
3.2k
RailsのPull requestsのレビューの時に私が考えていること
yahonda
5
2.4k
ピラミッド、アイスクリームコーン、SMURF: 自動テストの最適バランスを求めて / Pyramid Ice-Cream-Cone and SMURF
twada
PRO
10
1.1k
gopls を改造したら開発生産性が高まった
satorunooshie
8
270
GCCのプラグインを作る / I Made a GCC Plugin
shouth
1
150
Nurturing OpenJDK distribution: Eclipse Temurin Success History and plan
ivargrimstad
0
240
約9000個の自動テストの 時間を50分->10分に短縮 Flakyテストを1%以下に抑えた話
hatsu38
24
12k
破壊せよ!データ破壊駆動で考えるドメインモデリング / data-destroy-driven
minodriven
17
4.2k
Featured
See All Featured
Into the Great Unknown - MozCon
thekraken
32
1.5k
Writing Fast Ruby
sferik
626
61k
Fashionably flexible responsive web design (full day workshop)
malarkey
404
65k
Bootstrapping a Software Product
garrettdimon
PRO
305
110k
Being A Developer After 40
akosma
86
590k
GitHub's CSS Performance
jonrohan
1030
460k
A Tale of Four Properties
chriscoyier
156
23k
Principles of Awesome APIs and How to Build Them.
keavy
126
17k
Cheating the UX When There Is Nothing More to Optimize - PixelPioneers
stephaniewalter
280
13k
How to Think Like a Performance Engineer
csswizardry
20
1.1k
10 Git Anti Patterns You Should be Aware of
lemiorhan
654
59k
Happy Clients
brianwarren
97
6.7k
Transcript
Никита Соболев github.com/sobolevn
Continous Documentation Repeatable Software Development Process
Repeatable Software Development Process • Платим только за закрытые задачи
• Маленькие задачи, по одной за раз • Код, трекер и документация - больше ничего https://wemake.services/meta
Мы говорим только про внутреннюю техническую документацию
None
Почему программисты не любят писать документацию? • Им за нее
не платят • Они могут черпать знания в других источниках • Они и так все знают
Они и так все знают • Работают над одной частью
системы • Копят знания • Не делятся ими
Наше решение Распределять задачи случайным образом
Другие источники • Написал в телеге • Подошел - спросил
• Где-то в почте было
Наше решение Запретить общаться неформально
Мне за ... не платят
Наше решение Платить!
None
None
Проверяй, что пишешь! swagger-conformance doc8 swagger-spec-validator flex jsdoc remark-lint eslint-plugin-jsdoc
eslint-config-jsdoc-essential flake8-docstrings sphinx mypy flow
Hot start • https://github.com/wemake-services/ wemake-vue-template • https://github.com/wemake-services/ wemake-django-template
Проблемы • Попробуй продай! • "У вас такое никогда не
будет работать" • Взаимодействие с другими командами
Вопросы? github.com/sobolevn
[email protected]