이 페이지에는 Google 시즌의 Docs에 승인된 기술 글쓰기 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 구성:
- Kolibri
- 기술 문서 작성자:
- StephDix
- 프로젝트 이름:
- Kolibri 생태계 문서 스타일 및 워크플로 약관
- 프로젝트 길이:
- 장기 실행 (5개월)
Project description
개요
이 문서에서는 Learning Equality의 Kolibri 생태계 프로젝트에 관한 문서화된 정보에 스타일 가이드라인과 워크플로 관리를 구현하는 방법을 자세히 설명합니다.
개요
제안서는 4단계로 구성됩니다. 첫 번째 단계에서는 소프트웨어 개발의 LE 개념 및 스타일 가이드에 따라 접근성 가이드라인, 작성, 형식 권장사항이 포함된 LE 문서 스타일 가이드를 완성합니다. 두 번째 단계에서는 ReadTheDocs 및 GoogleDocs 문서에 대한 품질 감사를 수행합니다. 감사 계획은 스타일 가이드라인 준수를 평가하기 위해 체크리스트를 통합합니다. 이러한 체크리스트는 결과를 기록하고 변경사항을 문서에 적용하는 데 도움이 됩니다. 세 번째 단계에서는 ReadTheDocs 및 Google Docs 문서의 템플릿 구조, 디자인, 느낌을 살펴봅니다. 향후 구현 시 재사용할 수 있도록 Google Drive에 기본 문서 유형의 각 템플릿 카테고리를 식별하는 템플릿 및 이미지 저장소를 만들겠습니다. 풀 리퀘스트 검토에서 쉽게 식별할 수 있도록 문서 문제를 제출하는 템플릿을 만들어 이 작업을 보완하겠습니다. 마지막으로 정보에 액세스하는 데 도움이 되는 각 공동작업자 그룹의 유용한 리소스를 그룹화하는 참여자 가이드를 만들겠습니다.
목적 및 범위
이 구현 계획의 목적은 Kolibri 문서를 사용하는 최종 사용자의 환경을 개선하고 팀원과 참여자가 더 나은 문서를 작성하고 커뮤니티에서 적극적으로 협력할 수 있도록 지원하는 것입니다. 이 구현은 Kolibri 생태계의 ReadTheDocs 및 Google Docs 문서 하위 집합에 적용됩니다.
잠재고객
구현자, 관리자 및 최종 사용자로 구성된 주요 대상은 Kolibri 문서의 가장 중요한 소비자입니다. 팀원과 공동작업자로 구성된 2차 대상: Kolibri 문서 제작 및 사용
목표
Kolibri Ecosystem 문서의 스타일 가이드 및 워크플로 시스템은 사용자가 다음 작업을 하기를 기대합니다. 접근성이 우수한 언어와 일관된 레이아웃으로 이해하기 쉬운 문서를 작성해야 합니다. 문서화 시 품질 관행을 유지합니다. 문서 채널 간에 정보에 쉽게 액세스할 수 있습니다. Kolibri 오픈소스 커뮤니티의 공동작업 이니셔티브를 강화합니다.
정보 출처
Kolibri, Kolibri Studio, Kolibri 개발 RTD 문서, Google Drive의 Kolibri 도구 키트를 참고했습니다.
멋진 라디나 마티치님이 워밍업 활동과 프로젝트별 활동을 제공하는 데 큰 도움이 되었습니다. 조직에서 '가이드라인'과 '가이드'로 구분하는 개념과 참여자를 위한 가이드의 존재에 관한 의견을 바탕으로 아이디어를 정리하고 결론 초안을 작성할 수 있었습니다.
소프트웨어
Google Docs에서 스타일 가이드 초안을 작성하겠습니다. 이 문서 플랫폼은 게시할 준비가 될 때까지 반복하는 데 적합합니다. 품질 보증 감사의 경우 Google Forms를 사용하여 문서를 실행하고 평가합니다. 스프레드시트는 문서 관리를 위한 양식 응답을 저장합니다. GitHub를 사용하여 RTD 문서를 리팩터링합니다. Git, Gitkraken, GitHub, Gitlab을 사용해 작업한 적이 있습니다. 마크다운과 몇 가지 RestructuredText에 대한 실무 지식이 있습니다. 문법을 계속 학습하기 위해 문서 수정에 참여할 계획입니다. 이미지와 GIF에는 Sharex를 사용하겠습니다. 다양한 출력 형식으로 렌더링되기 때문에 이 도구를 좋아합니다. 다이어그램 및 이미지 수정에는 Diagrams를 사용하겠습니다. 다이어그램 소프트웨어는 Google Docs, Google Drive, LibreOffice와 완벽하게 통합됩니다. 문서화 상태 탐색 단계에서 Kolibri의 문서 대부분을 수정했습니다. 문법 오류, 오타, 레이아웃의 불일치, 서체, 이미지 사용 및 대부분의 프로젝트 문서에서 문서 경로가 혼동되는 것을 발견했습니다. 예를 들어 Kolibri 사용자 가이드에서 문제 해결 섹션은 주제가 아닌 하위 주제입니다. 이 정보는 최종 사용자가 목차에서 액세스할 수 있을 만큼 중요합니다. 두 번째 방법으로 검색창과 목차 트리를 사용하여 다른 주제를 펼치고 문제 해결 도움말을 찾을 수 있습니다.
'문제 해결' 섹션에 액세스하려면 이 섹션을 검색하거나 'Klibri 관리'를 펼쳐 문제 해결이 문서의 일부로 포함되어 있음을 확인해야 합니다. 가이드와 가이드라인 비교 이 프로젝트 제안서에서는 LE Kolibri 사용자 문서 스타일 가이드와 LE 번역 가이드라인이라는 두 가지 문서를 분석했습니다. LE Kolibri 가이드에서 제안된 주제 개요 및 문서 계획과 가이드에서 개선이 필요한 몇 가지 사항에 대한 권장사항과 의견을 작성했습니다. LE 번역 가이드라인의 경우 스타일 가이드의 권장사항과 기존 관례에 따라 형식과 스타일을 변경했습니다. 분석 과정에서 가장 주목한 것은 가이드와 가이드라인으로 분류된 문서 사이에 존재하는 오해였습니다.
성과
품질 보증 감사 작업에서 자세히 설명하는 예비 양식을 사용하여 제안 및 의견을 제출하는 것 외에도 LE 번역 가이드의 품질을 확인했습니다. 다음은 평가를 통해 얻은 최종 의견입니다. ICU 구문 .js 웹사이트의 깨진 링크 이 가이드라인을 만드는 데 사용된 형식이 올바르지 않습니다. 이 문서는 가이드라인이 아닌 가이드입니다. 일관되지 않은 서체 제목과 제목의 잘못된 사용, 언어의 부적절한 사용, 축약어의 오용 대체 텍스트의 부적절한 사용 반복된 문/ 안내
두 문서의 결과는 이 제안서의 결과물에 포함됩니다.
프로젝트별 작업
- LE 사용자 문서 스타일 가이드 권장사항 (의견)
- 새로운 스타일과 형식의 LE 번역 가이드라인
- 주제 개요
- 프로젝트 일정
- 문서 작업