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