테크니컬 라이터 작업

현재 단계:
2020년 Docs 시즌 프로그램이 2021년 3월 15일에 종료되었습니다. 타임라인을 참고하세요.

다음은 Season of Docs를 위해 멘토링 중인 테크니컬 라이터와 협력하는 방법에 관한 오픈소스 조직을 위한 몇 가지 가이드라인입니다.

  • 테크니컬 라이터를 오픈소스 세계와 커뮤니티에 소개합니다.
  • 테크니컬 라이터가 프로젝트 기여와 관련된 도구와 프로세스를 사용할 수 있도록 지원합니다.
  • 기술 작성자가 제품의 개념을 확실히 이해할 수 있도록 제품을 자세히 설명합니다. 이렇게 하면 테크니컬 라이터가 프로젝트에 대한 글쓰기에 더 자신감을 느끼고 더 권위를 가질 수 있습니다.
  • 잠재고객의 니즈, 즉 제품을 사용하는 개발자나 제품을 사용하는 다른 그룹의 요구사항을 설명합니다.
  • 테크니컬 라이터가 필요한 문서를 설계할 수 있도록 테크니컬 라이터와 함께 중요한 사용 사례를 논의합니다.
  • 테크니컬 라이터가 문서를 작성하기 전에 코드를 이해해야 하는 경우 코드를 살펴봅니다.
  • 테크니컬 라이터에게 필요한 주제별 전문가와 연락합니다. 즉, 문서에서 다루는 제품의 측면을 담당하는 개발자 또는 기타 프로젝트 기여자입니다.
  • 기술 작성자가 주제 전문가 및 다른 커뮤니티 구성원으로부터 필요한 시간과 리소스를 확보하도록 합니다.
  • 테크니컬 라이터와 협력하여 관련 있는 문서에 의미 있는 코드 샘플을 추가합니다.

주의사항

Season of Docs의 오픈소스 멘토가 반드시 테크니컬 라이터일 필요는 없습니다. 문서화 기술이 없어도 멘토가 될 수 있습니다. 테크니컬 라이터는 이러한 기술을 프로젝트와 멘토링 관계에 적용합니다.

대신 멘토는 오픈소스 커뮤니티, 제품, 오픈소스 프로젝트에서 사용하는 프로세스 및 도구에 대한 지식을 제공합니다.

멘토링 관계의 중요한 성과는 기술 작성자가 올해 Docs 시즌에서 보람 있고 성공적인 경험을 쌓았다는 것입니다. 행복한 경험을 하면 테크니컬 라이터가 올해 Docs 시즌이 끝난 후에도 오픈소스 프로젝트에 계속 기여할 가능성이 높아지고, 다른 테크니컬 라이터들은 오픈소스 작업에 열정적으로 참여할 수 있게 됩니다.