Upgrade to Pro — share decks privately, control downloads, hide ads and more …

How to design a library

Sponsored · Ship Features Fearlessly Turn features on and off without deploys. Used by thousands of Ruby developers. →
Avatar for Iskander (Alex) Sharipov Iskander (Alex) Sharipov
April 25, 2020
Programming
0
310

How to design a library

Богдан Сторожук.

Avatar for Iskander (Alex) Sharipov

Iskander (Alex) Sharipov

April 25, 2020
Tweet

More Decks by Iskander (Alex) Sharipov

See All by Iskander (Alex) Sharipov
quasigo
Avatar for Iskander (Alex) Sharipov quasilyte
0
89
Go gamedev: XM music
Avatar for Iskander (Alex) Sharipov quasilyte
0
140
Zero alloc pathfinding
Avatar for Iskander (Alex) Sharipov quasilyte
0
640
Mycelium
Avatar for Iskander (Alex) Sharipov quasilyte
0
91
Roboden game pitch
Avatar for Iskander (Alex) Sharipov quasilyte
0
260
Ebitengine Ecosystem Overview
Avatar for Iskander (Alex) Sharipov quasilyte
1
940
Go gamedev patterns
Avatar for Iskander (Alex) Sharipov quasilyte
0
510
profile-guided code analysis
Avatar for Iskander (Alex) Sharipov quasilyte
0
380
Go inlining
Avatar for Iskander (Alex) Sharipov quasilyte
0
140

Other Decks in Programming

See All in Programming
受け入れテスト駆動開発(ATDD)×AI駆動開発 AI時代のATDDの取り組み方を考える
Avatar for Takasaki Kazunari kztakasaki
2
560
nuget-server - あなたが必要だったNuGetサーバー
Avatar for Kouji Matsui kekyo
PRO
0
230
20260228_JAWS_Beginner_Kansai
Avatar for Takuya Yonezawa takuyay0ne
5
490
AIコーディングの理想と現実 2026 | AI Coding: Expectations vs. Reality 2026
Avatar for Tomohisa Takaoka tomohisa
0
1.2k
ベクトル検索のフィルタを用いた機械学習モデルとの統合 / python-meetup-fukuoka-06-vector-attr
Avatar for monochromegane monochromegane
2
390
ふつうの Rubyist、ちいさなデバイス、大きな一年
Avatar for bash0C7 bash0c7
0
830
encoding/json/v2のUnmarshalはこう変わった：内部実装で見る設計改善
Avatar for Hiroki Kurasawa kurakura0916
0
400
new(1.26) ← これすき / kamakura.go #8
Avatar for utagawa kiki utgwkk
0
2.2k
エージェント開発初心者の僕が エージェントを作った話と今後やりたいこと
Avatar for ta-hasunuma thasu0123
0
240
今更考える「単一責任原則」 / Thinking about the Single Responsibility Principle
Avatar for philomagi tooppoo
3
1.6k
AIコードレビューの導入・運用と AI駆動開発における「AI4QA」の取り組みについて
Avatar for ハゲワシ hagevvashi
0
430
Goの型安全性で実現する複数プロダクトの権限管理
Avatar for ishikawa-pro ishikawa_pro
1
250

Featured

See All Featured
BBQ
Avatar for Matthew Crist matthewcrist
89
10k
Leo the Paperboy
Avatar for Maya Tellez mayatellez
4
1.5k
Beyond borders and beyond the search box: How to win the global "messy middle" with AI-driven SEO
Avatar for David Carrasco davidcarrasco
3
68
Keith and Marios Guide to Fast Websites
Avatar for Keith Pitt keithpitt
413
23k
Marketing Yourself as an Engineer | Alaka | Gurzu
Avatar for Gurzu gurzu
0
150
svc-hook: hooking system calls on ARM64 by binary rewriting
Avatar for Akira Moroo retrage
2
160
The MySQL Ecosystem @ GitHub 2015
Avatar for Sam Lambert samlambert
251
13k
The Mindset for Success: Future Career Progression
Avatar for Greg Gifford greggifford
PRO
0
270
Effective software design: The role of men in debugging patriarchy in IT @ Voxxed Days AMS
Avatar for Kenny Baas-Schwegler baasie
0
250
How to Ace a Technical Interview
Avatar for Jacob Kaplan-Moss jacobian
281
24k
My Coaching Mixtape
Avatar for mlcsv mlcsv
0
69
Scaling GitHub
Avatar for Zach Holman holman
464
140k

Transcript

  1. How to please everyone

  2. How to please everyone or random thoughts about library design

  3. What we will talk about

  4. What we will talk about • Design your library API

  5. What we will talk about • Design your library API

    • Make it clear, effective, predictable and transparent

  6. What we will talk about • Design your library API

    • Make it clear, effective, predictable and transparent • Choose between alternative implementations

  7. What we will talk about • Design your library API

    • Make it clear, effective, predictable and transparent • Choose between alternative implementations • Assess your choices

  8. About me

  9. About me

  10. About me

  11. About me

  12. Disclaimer This talk is based on personal experience

  13. Your users

  14. Your users •Regular users

  15. Your users •Regular users •Advanced users

  16. Your users •Regular users •Advanced users •Experts

  17. Your users •Regular users •Advanced users •Experts

  18. Your users •Regular users •Advanced users •Experts

  19. Your users •Regular users •Advanced users •Experts

  20. Regular users

  21. Regular users

  22. Regular users

  23. Regular users

  24. None
  25. None

  26. Example

  27. Example

  28. Example github.com/storozhukBM/verifier

  29. Example github.com/storozhukBM/verifier

  30. copy&paste friendliness • Meaningful method names

  31. copy&paste friendliness • Meaningful method names • Zero configuration

  32. copy&paste friendliness • Meaningful method names • Zero configuration •

    Familiar patterns

  33. copy&paste friendliness • Meaningful method names • Zero configuration •

    Familiar patterns • Testability

  34. copy&paste friendliness • Meaningful method names • Zero configuration •

    Familiar patterns • Testability • No state management

  35. Examples github.com/pkg/errors

  36. Examples github.com/robfig/cron

  37. Examples github.com/robfig/cron

  38. Examples github.com/robfig/cron

  39. Examples github.com/robfig/cron

  40. Examples github.com/robfig/cron

  41. Advanced users

  42. None

  43. Advanced users

  44. Pragmatism friendliness • Meaningful method names • Zero configuration •

    Familiar patterns • Testability • No state management

  45. Pragmatism friendliness • Meaningful method names • Zero configuration Reasonable

    defaults • Familiar patterns • Testability • No state management

  46. Pragmatism friendliness • Meaningful method names • Zero configuration Reasonable

    defaults • Familiar patterns • Testability Introspection • No state management

  47. Pragmatism friendliness • Meaningful method names • Zero configuration Reasonable

    defaults • Familiar patterns • Testability Introspection • No state management (by default)

  48. Optional configuration

  49. Optional configuration github.com/tidwall/buntdb

  50. Optional configuration github.com/tidwall/buntdb

  51. Optional configuration github.com/valyala/fasthttp

  52. Introspection

  53. Introspection github.com/valyala/fasthttp

  54. Introspection github.com/valyala/fasthttp

  55. Introspection github.com/resilience4j/resilience4j

  56. Introspection github.com/resilience4j/resilience4j

  57. Introspection github.com/resilience4j/resilience4j

  58. Introspection github.com/resilience4j/resilience4j

  59. Introspection github.com/resilience4j/resilience4j

  60. Experts

  61. Experts

  62. Experts

  63. Expert friendliness • allocations controll

  64. Expert friendliness • allocations controll • zero-cost abstractions

  65. Expert friendliness • allocations controll • zero-cost abstractions • cost

    modelling

  66. Expert friendliness • allocations controll • zero-cost abstractions • cost

    modelling • paradigm agnostics

  67. Expert friendliness • allocations controll • zero-cost abstractions • cost

    modelling • paradigm agnostics • multi-level API

  68. Tools •Profiler

  69. Tools •Profiler •Tracer

  70. Tools •Profiler •Tracer •Throughput benchmarks

  71. Tools •Profiler •Tracer •Throughput benchmarks •Latency benchmarks

  72. Tools •Profiler •Tracer •Throughput benchmarks •Latency benchmarks •Allocations profiling

  73. Allocations control github.com/storozhukBM/verifier

  74. Allocations control github.com/storozhukBM/verifier

  75. Allocations control github.com/storozhukBM/verifier

  76. Allocations control github.com/storozhukBM/verifier

  77. Zero-cost abstractions “not pay for what you don't use”

  78. Zero-cost abstractions github.com/resilience4j/resilience4j

  79. Zero-cost abstractions github.com/resilience4j/resilience4j

  80. Cost modelling

  81. None
  82. None
  83. None
  84. None

  85. Paradigm agnostics

  86. Paradigm agnostics

  87. Is it even possible? •Regular users •Advanced users •Experts

  88. None
  89. None

  90. Multi-level API

  91. Multi-level API

  92. Multi-level API

  93. Multi-level API

  94. Multi-level API

  95. One more thing

  96. None

  97. One more thing

  98. Backward compatibility

  99. API State Clear Stateless Predictable Transparent Effective Summary

  100. FIN