24P by xguru 2022-06-27 | favorite | 댓글 1개

프레임워크와 라이브러리

  • 최대한 빠르게 온보딩 가능
  • 업그레이드 쉬움
  • 도움되는 에러 메시지
  • 강력한 기본값과 컨벤션
  • 기본 값 설정에서 탈출 가능하게 만들기
  • 종속성으로 위험 감소

문서

  • 코드로 설명하기(예제 제공)
  • 문제 해결해주기(질문에 대한 답변)
  • 자동으로 문서 생성(API 문서등을 최신으로 유지)
  • 에러에 대한 해결방법도 정리
  • Skimming(대충 읽기)에 최적화 하기
  • 정확할 것(전문용어와 관용구 피하기)
  • 복잡한 것들은 점진적으로 노출하기

APIs

  • API 워크플로우를 깨지 말 것 (Versioning) : Stripe 처럼
  • API를 빠르게 테스트 해볼수 있게 할 것 : Square가 이걸 잘함

"Skimming(대충 읽기)에 최적화 하기"는 엄청 공감되네요