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