사례 연구 만들기

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

2021년 Docs 시즌에 따라 조직은 최종 평가와 우수사례를 제출해야 합니다. 우수사례 템플릿 및 샘플 우수사례를 가이드로 사용하여 프로젝트의 우수사례를 만들어 보세요.

최종 평가 양식은 최소 2021년 11월 30일 18:00(UTC)에 제공됩니다.

우수사례 개요

우수사례 템플릿에는 다음 섹션이 포함됩니다.

  • 문제 서술: 신규 또는 개선된 문서로 해결하고자 했던 문제는 무엇인가요?
  • 제안서 개요: 조직 제안서 원본에 대한 간략한 요약
  • 프로젝트 설명: 프로젝트에 대한 설명 다음 사항을 포함하세요.
    • 제안서를 생성한 방법 및 원래 프로젝트 아이디어 페이지로 연결되는 링크
    • 테크니컬 라이터 또는 기타 참가자를 모집하고 선정한 방법
    • 프로젝트에 참여한 사람 (참여자가 요청하는 경우 사용자 이름 사용)
    • 프로젝트를 완료하는 데 걸린 시간 (완료된 경우)
    • 어떤 점이 마음에 드셨나요?
    • 예상치 못한 사항 어떤 장애물이나 차질을 겪었나요?
    • 어떤 문서가 작성, 업데이트, 개선 또는 삭제되었나요?
  • 이 프로젝트로 인해 조직에 프로세스 또는 절차가 새로 추가 또는 업데이트되었나요?
  • 측정항목:
    • 프로젝트의 성공을 측정하기 위해 어떤 측정항목이 선택되었나요?
    • 이러한 측정항목을 수집할 수 있었나요?
    • 그 수치가 예상한 행동 또는 업계 기준치와 상관관계가 있었나요?
    • 선택한 측정항목이 변경되었나요? 측정항목을 삭제하거나 추가하셨나요?
    • 측정항목에 따르면 프로젝트가 성공했나요? (다만 그렇게 말하기 어려울 수 있습니다.)
    • 앞으로 얼마나 자주 측정항목을 수집할 예정이신가요?
  • 요약:
    • 프로젝트 경험을 2~4문장으로 요약하세요. 무엇을 배웠나요? 향후 무엇을 다르게 하고 싶으신가요? 문서화와 유사한 문제를 해결하려는 프로젝트에 어떤 조언을 하고 싶으세요?

우수사례 가이드

  • 프로젝트 업데이트 사항을 매주 기록해 두면 사례 연구를 작성하는 데 도움이 됩니다. 매주 프로젝트 진행 상황(유용할 경우 pull 요청, 문제 또는 대화에 대한 링크 포함), 좋았던 점과 잘하지 못한 점, 학습한 내용, 질문한 내용을 기록합니다.
  • 우수사례를 작성할 때는 친절하게 행동하세요. 비난하지 말고 건설적으로 작성하세요. 우수사례는 공개됩니다.
  • 블로그 게시물이나 튜토리얼에서와 동일한 어조를 사례 연구에서도 사용하세요. 지나치게 격식을 차리지 마세요.