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