이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 구성:
- Open Collective
- 테크니컬 라이터:
- Anna e só
- 프로젝트 이름:
- 일반 도움말 문서 개선
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
첫인상 지원 미디어 (동영상, GIF, 이미지) 없이 안내가 포함된 문서 페이지가 있는 반면 동일한 챕터의 다른 섹션에는 더 완전한 항목이 있는 경우가 많습니다. 예를 들어 공동체 수정은 안내로만 구성되어 있는 반면 재무 호스트 추가는 지원 미디어를 통합합니다.
탐색한 페이지에서는 대체 텍스트 속성으로 미디어가 설명되지 않았습니다. 이미지 설명이 없으면 스크린 리더를 사용하는 사용자와 인터넷 연결 속도가 느려 미디어가 로드되지 않을 수 있는 사용자는 문서를 완전히 이해하기 어렵습니다.
문서의 일부 섹션에서는 재무 호스트 변경과 같이 FAQ와 사용자 인터페이스 탐색을 위한 직접 안내를 병합합니다. 문서 인터페이스에 목차가 없으므로 등록 레코드 변경의 결과를 알고 객관적인 안내만 원하는 사용자는 문서가 장황하고 너무 부수적인 것으로 인식할 수 있습니다.
기술 문서의 언어는 매우 일관성이 있지만 공개적으로 제공되는 스타일 가이드에는 문서 작성 방법에 관한 내용이 너무 적습니다. 참여 페이지에 기술 문서에 대한 참여가 언급되어 있으므로 Open Collective와 잠재적 참여자 모두 더 포괄적인 가이드라인을 활용하면 도움이 됩니다.
제안서 사용자 도움말 페이지를 검토하여 표시 방식과 현재 구조를 다시 생각해 볼 것을 제안합니다.
방법론 및 일정 다양한 기간의 지속적인 피드백 주기를 장려하는 커뮤니티와 협력하여 Open Collective 문서를 개선하고자 합니다.
커뮤니티 결속 기간 (2019년 8월 1일~9월 1일): Open Collective 커뮤니티 알아보기 주요 프로젝트의 활동 중인 구성원을 인터뷰하고 문서의 현재 상태에 대해 질문합니다 (보고서 1). 문의 및 문제를 추적하는 데 사용되는 모든 내부 시스템과 Open Collective 문서에 문의 및 문제를 문서화하는 절차를 기록합니다 (보고서 2). 문서의 현재 버전에서 잠재 문제 평가 및 해결 계획 준비 (보고서 3)
9월 2~6일: 커뮤니티 결속 기간 동안 커뮤니티에서 제기한 모든 의견과 제안을 고려한 첫 번째 의견 및 조정 주기 계획이 잘 진행되고 있나요? 변경해야 할 사항이 있나요? (보고서 4)
9월 9일~20일: 문서의 내용이 적은 챕터를 활용해 개념 증명 개발 공개 스타일 가이드 초안 (보고서 5호)
9월 23~25일: 평가를 위한 개념 증명 제출 (비공개 그룹).
9월 26~27일: 개념 증명이 출시되기 전에 조정이 필요한가요? 시간이 더 필요하신가요? 적절하게 조정합니다. (보고서 6)
9월 30일~10월 9일: 개념 증명이 게시됩니다. 두 번째 피드백 주기 (공개 그룹)
10월 10~15일: 최종 개념 증명 평가 및 조정 주기 (보고서 7)
10월 16~20일: 활동을 잠시 중단합니다[1].
10월 21일~11월 23일: 공개 스타일 가이드가 최종 완성되었습니다 (보고서 8호). 스타일 가이드에 있는 모든 안내를 모든 사용자 문서 페이지에 적용했습니다 (신고서 #9). 수행된 모든 활동을 평가하고 커뮤니티에 대한 추가 권장사항을 보고합니다 (보고서 10).
요청 시 프로젝트 기간을 연장할 수 있습니다.
[1]: Docs Season 신청 전에 계획된 여행입니다.
결과물 - 수행된 활동에 관한 공개 보고서 10개 - Open Collective 및 외부 참여자가 모두 사용할 수 있는 공개 스타일 가이드 - 개선된 사용자 문서 페이지