▲
neo 8달전 | parent | favorite | on: GN⁺: esbuild와 Redis, 훌륭한 아키텍처 문서를 갖춘 두 개의 오픈 소스 프로젝트(johnjago.com)
Hacker News 의견

  • Redis의 창시자 Antirez가 자신의 블로그에 코드 주석에 대한 생각을 상세히 설명한 글을 작성함. Redis에서 사용되는 9가지 유형의 주석을 식별함.

    • 많은 사람들이 중요하지 않다고 생각하는 "가이드 주석"의 사용에 놀랐음.
    • Antirez는 이러한 주석이 코드 이해를 돕는 데 가치가 있다고 결론지음.
    • Antirez의 글

  • 프로젝트 문서화가 사용자/개발자/기여자에게 어떻게 훌륭할 수 있는지에 대한 구체적인 예와 스크린샷을 포함한 잘 작성된 기사.

    • 자신의 작업과 부수적인 프로젝트에 대해 성찰하게 만들며, 문서를 개선하여 이해를 돕는 방법에 대해 생각하게 함.
    • 개발자로서 성장하면서 문서와 테스트를 더 많이 작성하게 됨. 일부 프로젝트는 실제 코드보다 문서와 테스트가 더 많음.
    • 좋은 문서를 작성하는 것은 코드를 작성하는 것과 다른 기술 세트를 요구한다는 의견이 있음. 때로는 기술적이지 않거나 개발에 집중하지 않는 사람이 설명하는 데 더 나을 수 있음.
    • 자동 생성된 문서도 유용할 수 있으며, 단독으로만이 아니라 추가 참조 자료로서의 가치가 있음.

  • 저장소의 품질에 대한 관리자들의 관심을 보여줌.

  • "The Architecture of Open Source Applications" 시리즈를 떠올리게 함. 흥미로운 통찰력이 있음.

  • GitLab의 문서가 매우 좋다는 평판이 있지만, 직접 사용할 필요가 많지 않았음. 그들의 아키텍처 문서가 좋은지에 대한 의문.

  • Postgres 프로젝트도 문서, readme 파일, 코드 주석에 상세한 주의를 기울임.

  • esbuild 프로젝트의 아키텍처 문서화에 깊은 인상을 받음. 과거에 작업했던 코드베이스에 이런 문서가 있었다면 좋았을 것임.

    • 이러한 수준의 아키텍처 문서화를 가진 다른 프로젝트 예시에 대한 질문.

  • 오픈 소스 프로젝트의 변경 로그를 매우 좋아함. 이익을 추구하는 다른 엔티티보다 훨씬 전문적이고 유익함. ING 은행의 앱 변경 로그가 유머러스하기보다는 정보 제공에 집중해야 한다는 비판.

  • "오늘날 자유 소프트웨어 커뮤니티에서 가장 큰 결핍은 소프트웨어가 아니라, 자유 소프트웨어와 함께 포함할 수 있는 좋은 자유 문서의 부족이다."

    • gdb 매뉴얼 인용.

  • Redis가 더 이상 오픈 소스가 아니라는 것을 언급함. Redis는 Redis Source Available License v2 (RSALv2)와 Server Side Public License v1 (SSPLv1) 하에 "소스-사용 가능" 소프트웨어임.

    • Redis Stack과 Redis Ltd.가 만든 모든 Redis 모듈(예: RediSearch, RedisJSON, RedisGraph, RedisTimeSeries, RedisBloom)은 RSALv2와 SSPL로 이중 라이선스됨.
    • Redis Enterprise는 폐쇄 소스이며 Redis Ltd.로부터 상업 라이선스가 필요함.
    • 이전 버전의 Redis는 3-clause BSD 라이선스(자유롭고 오픈 소스) 하에 있음. 라이선스 변경은 소급 적용되지 않으며, 변경 전의 모든 소스 코드와 릴리스는 원래의 3-clause BSD 라이선스를 유지함. 해당 조건을 준수하는 한, 이러한 버전을 무기한 사용할 수 있음.
    • Redis 라이선스
    • BSD 라이선스