이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- HPX
- 테크니컬 라이터:
- rstobaugh
- 프로젝트 이름:
- 기존 HPX 문서 수정 및 간소화
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
기존 HPX 문서의 콘텐츠를 수정하고 간소화하는 것이 좋습니다. 제안은 STE||AR 그룹 매뉴얼의 두 챕터인 'HPX 빌드 시스템 및 실행'(1)과 'HPX 애플리케이션 구성' (2)을 수정하는 데 중점을 둔 표준 기간(3개월) 프로젝트입니다.
'HPX 빌드 시스템 및 실행' 장에 문법 오류가 여러 개 있으며 혼동을 야기하는 표현과 'CMake'와 같은 용어의 대소문자 불일치가 있습니다. 또한 중복된 정보가 포함되어 있으며, 필요에 따라 재정렬, 통합, 수정할 계획입니다. 'HPX 애플리케이션 구성' 챕터에도 해결해야 할 몇 가지 문법 오류가 있지만 이 챕터에서 가장 우려되는 점은 사용자 친화성입니다. 이 장에서는 다음과 같은 세 가지 주요 설계 문제를 다룹니다.
일부 제목이 텍스트 내에 묻혀 있어 챕터를 훑어보기가 어렵습니다. 현재 사용자가 각 표의 목적을 이해하려면 설명서를 주의 깊게 읽어야 합니다. 하지만 대부분의 사용자는 특히 이전에 이미 콘텐츠를 읽은 적이 있는 경우 이렇게 안내서와 상호작용하지 않습니다. 대신 각 표에 명확하고 눈에 띄는 제목이 포함되도록 하여 사용자가 텍스트를 스크롤할 때 쉽게 볼 수 있도록 하려고 합니다.
특정 제목 아래에 다양한 속성을 나열할 때 속성이 논리적인 순서를 따르지 않습니다. 속성은 공통 테마로 그룹화되지만 하위 그룹이 없어 정보가 흩어져 있는 것처럼 보입니다. 예를 들어 한 사용자가 지역을 다루는 여러 속성, 다른 주제를 다루는 속성, 지역을 다루는 여러 속성을 만날 수 있습니다. 제목 아래에 내부 구조가 없으므로 특정 하위 주제에 관한 모든 정보를 찾기가 더 어렵습니다. 따라서 각 제목 아래에서 유사한 정보를 더 명확하게 그룹화할 수 있도록 여러 차트를 재구성할 계획입니다.
사용자는 특정 지침을 완전히 이해하려면 섹션 사이를 왔다 갔다 해야 합니다 (또는 두 개의 별도 탭에서 설명서를 열어야 함). 이전 섹션에서 '이 단계는 11단계 후에 실행됩니다'와 같은 모호한 표현을 사용하기 때문에 정확한 안내를 이해하기 위해 독자가 위로 스크롤하거나 하이퍼링크를 따라가야 하는 방식으로 이전 섹션 내의 단일 문장으로 사용자를 안내하는 부분이 있습니다. 이 방법은 반복을 없애지만, 특정 순서로 실행해야 하는 작업이므로 안내를 이해하기가 더 어려워집니다. 대신 사용자가 섹션이나 문서 간에 전환하여 읽기 프로세스를 중단하지 않아도 되도록 더 구체적인 문구를 포함하는 것이 좋습니다.
표준 타임라인이 완료되기 전에 이 섹션을 완료하면 STE||AR 그룹의 사용자 문서에 있는 'HPX 사용 이유'(3) 페이지도 정리하고 싶습니다. 이 페이지에는 반복되는 소개 콘텐츠가 포함되어 있으며, 통합이 필요합니다. 또한 대문자 (특히 전문 용어)와 어조가 일관되지 않아 통일감이 떨어집니다. STE||AR 그룹의 작업에 관한 보다 통합되고 일관된 소개를 만드는 것이 목표입니다.