Examples Are the Best Documentation
14 hours ago
- #documentation
- #examples
- #developer-experience
- Developers often need a single example to understand documentation, but official sources rarely provide this.
- Technical documentation is usually written for those deeply familiar with the ecosystem, making it hard for developers who switch contexts frequently.
- The Python `max()` function documentation is complex, requiring knowledge of multiple Python-specific concepts.
- Simple examples like `max(4, 6)` or `max(['x', 'y', 'abc'], key=len)` would be more helpful for quick understanding.
- Community-driven documentation, like clojuredocs.org, provides practical examples and related functions, making it more useful.
- Official documentation often lacks examples, leading developers to seek tutorials instead.