이 페이지에는 Google 시즌의 Docs에 승인된 기술 글쓰기 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- Julia 언어
- 테크니컬 라이터:
- mkg33
- 프로젝트 이름:
- 과학 머신러닝에 관한 통합 문서
- 프로젝트 길이:
- 장기 실행 (5개월)
Project description
SciML 조직 통합에 참여하고자 합니다. 이 분야에는 개선의 여지가 많으며 이 프로젝트가 완료되면 Julia 프로그래머와 SciML의 활발한 참여자/유지보수자 모두에게 즉각적인 이점이 제공될 것입니다. SciML에 흩어져 있는 패키지는 매우 유용한 도구를 제공하지만 사용자가 패키지를 찾아서 당면한 문제에 적용하지 못했다는 이유로 특히 신규 사용자가 패키지를 인식하지 못할 위험이 항상 있습니다.
이 패키지의 주요 목적이 광범위한 프로그래머 (초보자와 전문가 모두)에게 도달하는 것임을 감안하면 이는 다소 실망스러운 일입니다. 위에 설명된 상황을 방지하기 위해 SciML 문서의 '첫 페이지'를 철저히 수정하고 사용자가 관련 패키지를 탐색하고 성장하는 생태계를 탐색하는 데 사용할 수 있는 일종의 허브를 만드는 것이 좋습니다. 또한 경험이 많은 사용자에게 유용한 참조 자료가 되어 더 효율적으로 작업할 수 있도록 도와줄 수 있습니다.
먼저 모든 개별 패키지의 기존 문서는 가장 기본적인 스타일 문제 (철자, 구두점, 문법 등)와 관련하여 수정이 필요합니다. 스타일 일관성을 보장하기 위해 SciML에 구체적인 스타일 가이드가 있어야 합니다. 이 가이드는 회고적인 변경을 하거나 향후 참고할 때 반드시 필요합니다. 처음부터 시작하면 시간 낭비입니다. 대신 기존 Julia 규칙을 기반으로 하고 SciML 관련 문제의 새 항목을 포함해야 합니다.
스타일 가이드가 완료되면 프로젝트의 두 번째 단계에서 현재 문서를 수정하려고 합니다. 이렇게 하면 문서가 더 전문적이고 안정적으로 보입니다. 이 작업에 대한 제 접근 방식을 보여주는 몇 가지 풀 요청을 이미 작성했습니다. 이 단계에서는 효율적인 인용 시스템을 고안하고 구현할 계획입니다. 가장 먼저 오래된 인용 페이지를 업데이트해야 합니다.
세 번째 단계는 아마도 가장 중요한 단계로, 분산된 패키지 간의 상호작용을 강조하는 SciML 로드맵 설계입니다. 문제 또는 코드 자체와 관련하여 두 패키지 간의 응집력이 강할수록 '참고' 목록에 더 가깝게 표시되어야 합니다. 코드 유사성을 위한 추천 키와 문제 유사성을 위한 추천 키를 두 개 만들 것을 제안합니다. 이렇게 하면 사용자가 각 저장소와 문서를 번거롭게 탐색하는 것보다 훨씬 더 빠르게 유용한 다른 패키지를 식별할 수 있습니다. 패키지 간에 가능한 모든 연결을 나열하는 대신 큰 연결에 집중하고 더 작은 패키지로 링크를 표시하려고 합니다 (이 방법은 다른 패키지와의 연결을 언급해야 하는 업데이트 튜토리얼로도 확장됩니다). 이 접근 방식을 사용하면 '참고' 목록이 패키지 조합을 완전히 열거하지 않고도 유용한 정보를 제공할 수 있습니다.