현재 단계:
결과가 발표되었습니다. 타임라인을 참고하세요.
다음은 오픈소스 조직이 테크니컬 라이터와 효과적으로 작업하는 데 도움이 되는 몇 가지 가이드라인입니다.
기술 작가에게 오픈소스 세계와 커뮤니티를 소개합니다.
- 기술 작가에게 커뮤니티를 '둘러보는' 기회를 제공합니다. 어디에서 질문할 수 있나요? 어떤 정기 회의에 참석해야 하며 어떤 메일링리스트에 가입해야 하나요? 어떤 계정이 필요한가요 (Github, Discord, Slack)? 팀원들이 프로젝트의 윤리 강령을 이해하고 문제 신고 방법을 숙지하고 있는지 확인하세요. 기술 작가가 프로젝트의 라이선스를 이해하고 CLA, DCO 또는 기타 계약서 서명과 관련된 다른 고용주의 요구사항을 준수하는지 확인합니다.
- 가능하다면 시간대가 겹치고 커뮤니티 또는 프로젝트에 관한 질문에 빠르게 응답할 수 있는 사용자를 소개합니다.
- 가능하면 프로젝트 관련 상품을 보내주세요.
기술 작가가 프로젝트에 참여하는 데 필요한 도구와 프로세스를 사용할 수 있도록 지원
- 절차가 잘 문서화되어 있지 않다면 기술 작가가 첫 번째 참여, 문제 또는 풀 리퀘스트를 진행할 수 있도록 시간을 정해 안내하세요. 어떤 템플릿 또는 태그를 사용해야 하나요? 누가 참여 내용을 검토해야 하며 검토 후 어떻게 언제 후속 조치를 취해야 하나요? 작업에 코드 샘플이 포함된 경우 어떻게 테스트할 수 있나요? CI/CD 프로세스 또는 출시에 관해 무엇을 알아야 하나요?
기술 작가가 프로젝트와 사용자를 이해하도록 지원
- 기술 작가가 제품을 개념적으로 확실하게 이해할 수 있도록 프로젝트를 자세히 설명합니다. 이를 통해 기술 작가는 프로젝트에 대한 글을 작성할 때 자신감을 갖고 더 전문적인 어조를 사용할 수 있습니다.
- 프로젝트를 사용하는 사용자의 요구사항을 설명합니다. '개발자'뿐만 아니라 '웹사이트를 만드는 개발자', '산업용 로봇을 프로그래밍하는 개발자' 등 최대한 구체적으로 지정하세요.
- 테크니컬 라이터를 필요한 주제 전문가와 연결합니다. 즉, 문서에서 다룰 프로젝트 측면을 담당하는 개발자 또는 기타 프로젝트 참여자입니다.
- 기술 작가가 주제 전문가 및 기타 커뮤니티 회원으로부터 필요한 시간과 리소스를 확보할 수 있도록 합니다.
질문하기
- 커뮤니티 또는 프로젝트에서 이전에 기술 문서 작성자 또는 문서 작성자 참여자를 사용하지 않았을 수 있습니다. 알고 있는 정보를 공유하면서 학습의 기회를 활용하세요. 절차와 도구에 관한 의견을 요청하세요. 기술 작가가 개선을 위한 제안을 할 수 있습니다.