이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- Open Collective
- 테크니컬 라이터:
- 안나에소
- 프로젝트 이름:
- 일반 도움말 문서 개선
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
첫인상 지원 미디어 (동영상, GIF, 이미지)가 없는 도움말이 포함된 문서 페이지는 흔히 볼 수 있지만 같은 장에 있는 다른 섹션에는 더 완전한 항목이 있습니다. 예를 들어 Edit Collective는 안내로만 구성된 반면 Add Fiscal Host에는 지원 미디어가 통합되어 있습니다.
탐색한 페이지에서 대체 텍스트 속성을 사용하여 설명된 미디어가 없습니다. 이미지 설명이 없으면 스크린 리더를 사용하는 사용자와 미디어가 로드되지 않을 수 있는 느린 인터넷 연결을 사용하는 사용자가 문서를 제대로 이해하는 데 방해가 됩니다.
문서의 일부 섹션에서는 FAQ와 재무 호스트 변경과 같이 사용자 인터페이스 탐색을 위한 직접 안내를 병합합니다. 문서 인터페이스에 목차가 없기 때문에 등록 기록 변경의 결과를 알고 있고 객관적인 지침만 원하는 사용자는 문서가 너무 장황하고 너무 접선이라고 인식할 수 있습니다.
기술 문서의 언어는 상당히 일관적이지만 공개적으로 사용 가능한 스타일 가이드에서는 문서 작성 방법에 대한 문서가 거의 없습니다. 참여 페이지에는 기술 문서에 대한 기여가 언급되어 있으므로 Open Collective와 잠재적 참여자 모두에게 더 포괄적인 가이드라인이 도움이 될 수 있습니다.
제안 사용자 도움말 페이지를 검토하여 표시 방식과 현재 구조를 재고해 보라고 제안합니다.
방법론 및 타임라인 커뮤니티와 협력하여 다양한 기간의 지속적인 피드백 주기를 촉진하여 Open Collective 문서를 개선하고자 합니다.
커뮤니티 유대감 기간 (2019년 8월 1일~9월 1일): Open Collective 커뮤니티에 대해 알아보기 주요 프로젝트에서 활동 중인 멤버를 인터뷰하면서 문서의 현재 상태에 대해 질문합니다 (보고서 1). 쿼리 및 문제를 추적하는 데 사용되는 모든 내부 시스템과 이를 Open Collective Docs (보고서 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 시즌 전에 여행 계획이 있음
결과물 - 수행된 활동에 대한 공개 보고서 10개 - Open Collective와 외부 참여자 모두가 사용할 수 있는 공개 스타일 가이드 - 개선된 사용자 문서 페이지