이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- ScummVM
- 테크니컬 라이터:
- 캐디
- 프로젝트 이름:
- 문서 포털 실행
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
목표:
- 서로 다른 출처에서 가져온 대량의 정보를 통합하고 명확성, 일관성, 완전성을 위해 정보를 재작성하여 버전이 지정된 고품질의 최종 사용자 문서를 작성합니다.
- 문서는 기술에 능통한 사용자를 호도하지 않고 초보자가 쉽게 이해할 수 있어야 합니다.
- 정적 사이트 생성기를 사용하여 문서 포털을 만들려면
- 향후 오픈소스 기여자를 위한 템플릿 및 자세한 방법 안내를 만들어 최종 사용자 문서의 미래 경쟁력 확보
현재 상황:
- 사용 가능한 ScummVM 문서는 여러 소스에 분산되어 있습니다.
- 정보는 찾기 어렵고 중복될 때가 많으며, 찾기 어려운 페이지에서는 길을 잃기 쉽습니다.
- 어떤 정보가 최신이고 어떤 정보가 오래된 것인지 알기 어렵습니다.
- 일부 정보가 누락되었거나 불완전합니다.
문제 해결:
권장되는 문서 구조:
방문 페이지
|-- 시작하기
| -- Quick start guide
|-- Installing ScummVM
| |-- Nintendo 3DS
| |-- AmigaOS
| |-- Android
| |-- (every)
| |-- (common)
| |-- (supported)
|-- (플랫폼)
|-- ScummVM 사용
| |-- 런처
| |-- 전체 설정
| |-- 게임 설정
| -- Keyboard shortcuts
|-- Advanced options
| |-- Cloud and LAN
| |-- Control Mapping
| |-- Configuration
| |-- Command line options
| |-- Graphics
|-- 음악 및 사운드
|-- 도움말
| |-- FAQ
| |-- 연락처
| |-- 알려진 문제
| -- Reporting a bug
|-- Game Notes-- 출시 노트
- 시작하기:
신규 사용자는 최대한 빨리 시작하기 위해 빠른 시작 가이드를 찾는 경우가 많습니다. ScummVM 설치는 일부 플랫폼에서 복잡할 수 있지만 컴퓨터에 설치하는 것은 복잡하지 않습니다.
빠른 시작 가이드에서는 다음 내용을 다룹니다.
- Windows, Mac, Linux에 ScummVM을 설치하는 방법
게임 로드, 추가, 실행 방법
ScummVM 설치:
설치가 직관적이지 않거나 사용자의 기술 기반이 탄탄하지 않은 경우 지원되는 플랫폼에 ScummVM을 설치하기 위한 종합 가이드가 필요합니다.
각각의 포괄적인 설치 페이지에서는 다음 사항을 다룹니다.
- 시스템 요구사항/기본 요건
- 적절한 버전의 ScummVM을 다운로드하는 방법
- ScummVM 설치 방법
- 선택한 플랫폼(특히 게임 개발 대상 플랫폼이 아닌 경우)에 게임을 로드하는 방법
ScummVM 실행, 게임 추가, 게임 실행 방법
ScummVM 사용:
사용자에게는 ScummVM 사용 방법을 설명하는 참조 문서가 필요합니다.
참조 문서에는 다음 내용이 포함되어야 합니다.
- 런처 인터페이스: 각 창과 탭의 모양과 작동 방식입니다.
- 전 세계 및 게임별로 사용 가능한 설정에 관한 설명입니다.
단축키/핫키.
고급 옵션:
고급 사용자는 게임 실행 방식을 조정할 때 사용할 수 있는 옵션에 대한 더 자세한 기술 정보를 추가로 필요로 합니다.
- 게임 참고사항:
사용자가 알아야 하는 게임 관련 정보. - 설치 관련 특이사항 - 필요한 추가 파일 - 비정상적이거나 다른 컨트롤
- 알려진 문제:
이 섹션에는 해당 버전과 관련해 알려진 버그가 모두 포함되어야 합니다.
- 출시 노트:
설명서의 버전도 함께 관리할 예정이지만, 출시 노트 섹션이 있으면 최신 버전의 변경사항을 요약하여 제공하는 데 도움이 될 수 있습니다. 여기에는 새로 지원되는 게임이나 새 엔진에 관한 정보와 같이 현재 이 도움말에서 다루지 않는 영역이 포함될 수 있습니다.
공격 계획:
먼저 ScummVM 설치 페이지에 대한 템플릿을 만드는 것이 좋습니다. 포트 유지관리자/개발자 (특히 이러한 정보가 부족하거나 없는 경우)로부터 필요한 정보를 가장 쉽게 얻을 수 있기 때문입니다. 기존 문서에서 이미 가지고 있는 정보를 미리 채우면 완전성, 정확성, 통화를 확인하거나 필요에 따라 추가할 수 있습니다.
다음으로 기존 문서(리드미, 위키, 웹사이트)를 찾아보겠습니다. 필요에 따라 각 섹션을 다시 작성하고 추가한 다음 모든 정보를 새 포털로 가져올 것입니다. 또한 포털이 게시되면 중복, 모순 또는 기타 이상치가 발생하지 않도록 어디에서 어떤 정보를 가져오는지 기록해 둡니다.
이를 진행하는 동안 저는 멘토, 개발자, 포트 유지관리 담당자 및 기타 주제 전문가와 협력하여 누락된 정보의 출처와 각 페이지를 가능한 한 최신 상태로 포괄적으로 유지할 것입니다.
협업의 정신과 멘토의 승인을 받아 작성 프로세스 전반에 걸쳐 진행 중인 작업 포털에 ScummVM 커뮤니티에서 액세스할 수 있기를 바랍니다. 그러면 실시간 피드백을 받고 그 과정에서 누락된 부분이 없도록 할 수 있습니다.
Google 개발자 문서 스타일 가이드와 같은 스타일 가이드를 사용하여 이 작업 본문과 이후의 모든 문서에 일관성을 유지하는 것이 좋습니다.
가능하다면 이해를 돕기 위해 스크린샷, GIF, 기타 시각 자료를 활용하겠습니다.
추천 일정:
커뮤니티 유대감 2020년 8월 17일~9월 13일
프로젝트에 대한 비전을 세부적으로 조정하고 문서 구조 및 콘텐츠와 같은 세부정보를 마무리하기 위해 멘토 및 광범위한 ScummVM 커뮤니티와 지속적으로 소통합니다.
1주 차 9월 14일~9월 20일
- 플랫폼별 설치 페이지의 템플릿을 만듭니다.
- 템플릿에 기존 정보를 미리 채우고 추가 정보를 위해 적절한 포트 유지관리자/개발자에게 배포합니다.
2주 차 9월 21일~9월 27일
- 새 문서 포털 설정
3주 차 9월 28일~10월 4일
ScummVM 사용: - 인터페이스 - 전체 설정 ScummVM 설치: - 플랫폼별 설치 가이드가 완료된 템플릿으로 반환됩니다.
4주 차 10월 5일~10월 11일
ScummVM 사용: - 게임 설정 - 단축키 ScummVM 설치: - 완료된 템플릿이 나에게 반환되면 플랫폼별 설치 가이드
5주 차 10월 12일~10월 18일
고급 옵션: - 클라우드 및 LAN - 클라우드 및 LAN - 매핑 제어 ScummVM 설치: - 완성된 템플릿이 나에게 반환되면 플랫폼별 설치 가이드가 제공됩니다.
6주 차 10월 19일~10월 25일
고급 옵션: - 구성 - 명령줄 옵션 ScummVM 설치: - 플랫폼별 설치 가이드가 완료된 템플릿이 반환됨
7주 차 10월 26일~11월 1일
고급 옵션: - 그래픽 - 오디오 ScummVM 설치: - 플랫폼별 설치 가이드(완료된 템플릿이 나에게 반환됨)
8주 차 11월 2일~11월 8일
도움말: - FAQ - 주소록 - 알려진 문제
ScummVM 설치: - 완료된 템플릿이 나에게 반환되는 플랫폼별 설치 가이드
9주 차 11월 9일~11월 15일
도움말: - 버그 신고 - 게임 노트 - 출시 노트
ScummVM 설치: - 아직 완료하지 않은 플랫폼 가이드를 완료합니다.
10주 차 11월 16일~11월 22일
- 사이드바 탐색, 테마/CSS 조정 등 포털 관련 결정을 최종적으로 수정, 교정 및 완료합니다.
- 모든 링크가 예상대로 작동하는지 확인합니다.
- 이미지/gif가 제대로 표시되는지 확인하세요.
11주 차 11월 23일~11월 30일
- 남은 아이템을 모두 정리하고 공식적으로 포털을 출시하세요.
- 포털이 출시되면 멘토와 상의하여 다른 출처에서 중복된 정보를 삭제합니다.