이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- ScummVM
- 테크니컬 라이터:
- Cadi
- 프로젝트 이름:
- 문서 포털 실행
- 프로젝트 길이:
- 표준 기간 (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 - 컨트롤 매핑 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일
- 미완료 항목을 마무리하고 포털을 공식적으로 출시하세요.
- 포털이 출시되면 멘토와 상의하여 다른 소스에서 중복 정보를 삭제합니다.