Bolestivá cesta fragmentace trhu, velikosti zařízení, bugujících aplikací. Občas šílené řešení
Bulletproof email buttons design:
.app { | |
foreground: #dee2e6; | |
header-color: #f0f4f7; | |
bold-color: #dee2e6; | |
link-color: #2c8ad3; | |
background: #282c34; | |
syntax: #CCCCCC; |
Pojďme se společně podívat na to, jak napsat API dokumentaci tak, aby byla srozumitelná jak lidem, tak strojům. Jak ji udělat udržitelnou, verzovanou a snadno dostupnou.
Psaní dokumentace pro API je důležité, protože umožňuje vývojářům a dalším lidem, kteří s API pracují, snadné porozumění tomu, jak API funguje a jak se s ním pracuje. Zároveň je tato činnost často provázená značnou „bolestí”. Tato „bolest” pramení zejména z toho, že dokumentaci je potřeba udržovat, verzovat, doplňovat, upravovat nebo aktualizovat.