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