Frameworks और libraries
- जितना संभव हो उतनी जल्दी onboarding हो सके
- upgrade करना आसान हो
- काम आने वाले error messages
- मजबूत defaults और conventions
- default settings से बाहर निकलना संभव बनाना
- dependencies के ज़रिए जोखिम कम करना
Documentation
- code के ज़रिए समझाना (examples देना)
- समस्या हल करना (सवालों के जवाब देना)
- अपने-आप documentation generate करना (API docs आदि को up to date रखना)
- errors के समाधान भी व्यवस्थित करना
- skimming (सरसरी पढ़ाई) के लिए optimize करना
- सटीक होना (jargon और idioms से बचना)
- जटिल चीज़ों को धीरे-धीरे सामने लाना
APIs
- API workflow को टूटने न दें (versioning): Stripe की तरह
- API को जल्दी test कर सकने योग्य बनाएं: Square यह अच्छी तरह करता है
1 टिप्पणियां
"Skimming (सरसरी तौर पर पढ़ना) के लिए optimize करना" वाली बात से मैं पूरी तरह सहमत हूँ।