Hacker News 의견

• 소규모 라이브러리의 저자/관리자로서 외부 기여가 없었다면 매뉴얼이 지금만큼 좋지 않았을 것이라고 확인함. 매뉴얼은 프로젝트의 사용성에 크게 기여함.

  • libcurl의 새 사용자로서 튜토리얼과 API 문서 덕분에 FTP 업로드를 빠르게 구현하고 특정 사용 사례에 맞게 조정할 수 있었음.
  • 문서를 통해 구버전의 스레드 안전성 부족을 인지하고 팀에 업데이트할 것을 경고할 수 있었음.
  • 문서는 코드와 테스트 스위트만큼 중요함.

• 오픈 소스 프로젝트에 대한 바람:

  • 많은 스크린샷
  • 매우 길고 상세한 README.md
  • 튜토리얼, 참조 문서, 설계 문서, 아키텍처 다이어그램
  • 저자가 생각하는 방식을 설명하는 정신 모델 문서

• 오픈 소스에 있어 문서, 자산 등이 중요하지만, 비개발자에게 권력을 주어 프로젝트를 망칠 수도 있음.

  • UX를 매 릴리스마다 다시 만드는 등 안정성, 기능성, 채택에 해를 끼칠 수 있음.
  • 정치에 관심이 많은 사람들을 끌어들이고, 누구나 할 수 있다고 생각하는 영역에서 'bikeshedding'이 발생하기 쉬움.

• 커뮤니티 구축을 위해 Discord, Gitter, Slack과 같은 채팅 플랫폼을 사용하는 것이 좋음.

  • 사람들이 레포지토리에서 질문하는 것을 주저하지 않게 만듦.
  • GitHub에서 질문을 하거나 문제를 해결하는 풀 리퀘스트를 만드는 것이 종종 무의미하게 느껴짐.
  • GitHub 프로젝트 생성자들 사이에서 "코드를 공개했으니 그 이상의 것은 빚진 것이 없다"는 태도가 널리 퍼져 있음.

• WordPress 커뮤니티에서 활동한 경험을 바탕으로 초기 문서화와 Codex의 강력한 문서화가 WordPress의 성장에 크게 기여했다고 생각함.

  • Joomla, Drupal, WordPress가 설치 기반면에서 비슷했던 시기에 WordPress는 풍부한 문서 덕분에 시작하기가 더 쉬웠음.

• 오픈 소스 프로젝트에 대한 가장 큰 바람은 사람들이 그것을 사용하고 사용한 내용에 대해 어떤 형태로든 기록을 남기는 것임.

  • 프로젝트의 Discord 채널에 메시지를 남기거나, 트윗, 짧은 메시지, 스크린샷, gist, 공개 GitHub 레포지토리, YouTube 또는 TikTok 비디오 등이 모두 프로젝트에 매우 가치 있는 기여임.

• 비코드 기여가 프로젝트의 성공 비결인지는 확실하지 않지만, 매우 중요하다는 데 동의함.

  • 예를 들어, Eclipse Foundation은 버그 리포트도 가치 있는 기여라고 사용자들에게 상기시킴.

• 오픈 소스 프로젝트를 시작하는 과정에서, 실제로 코드를 작성할 엔지니어보다 10배 많은 엔지니어가 소프트웨어를 사용할 것이라는 예상이 있음.

  • 사용자가 문서를 개선하는 방법으로 기여할 수 있어야 함.
  • Hugo와 같은 정적 사이트 생성기를 사용하여 문서(사용자 매뉴얼)를 생성할 때, 사용자가 GitHub 이슈를 생성하지 않고도 문서에 대한 수정/업데이트를 제출할 수 있는 방법이 필요함.

• 비기술적인 사람들이 프로젝트를 이해하고 가치를 찾는다면, 프로젝트가 성공할 좋은 지표임.

• 제품이 알려지지 않은 상태에서 팬들에 의해 사용되는 단계에서 더 많은 사용자를 찾는 단계로 넘어갈 때 문서화가 중요함.

  • 좋은 문서 없이는 이 단계를 넘기 어려움.
  • Neural Amp Modeller의 사용자 가이드를 작성해야 한다는 것을 상기시킴.