CERN-HSF 프로젝트

이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:

CERN-HSF

테크니컬 라이터:

LuckInTheRain

프로젝트 이름:

ROOT 문서: 분석, 재구성, 재작성

프로젝트 길이:

장기 실행 (5개월)

Project description

이 프로젝트는 다음 4단계로 구성됩니다.

1.) 현재 ROOT 문서 분석

전체 ROOT 문서 (웹사이트, 사용자 가이드, C++ 참조, 튜토리얼 등)는 구조화, 모듈화, 표준화, 액세스 메커니즘, 일관성, 사용된 정보 유형, 대상 그룹별 준비 및 이해 가능성 등의 기준에 따라 분석 및 확인됩니다. 정보 관리를 위한 개념, 구조화를 위한 매트릭스, 콘텐츠 표준화를 위한 가이드라인을 만드는 것이 목표입니다.

2.) ROOT팀과 함께 소프트웨어 문서 작성 구조를 정의하는 방법 정의

소프트웨어 문서에 관한 OASIS 표준인 DITA (Darwin Information Typing Architecture)(https://www.oasis-open.org/committees/dita/)가 ROOT팀에 제출됩니다. 소프트웨어별 콘텐츠를 구성하는 방법과 '개념', '작업', '참조'와 같은 기본 정보 유형이 소프트웨어 문서 작성에 사용되는 방식을 이해하는 데 중점을 둡니다.

3.) ROOT 문서 재구성

처음 두 단계의 결과를 바탕으로 ROOT 문서는 타겟 그룹, 역할, 사용 사례에 따라 재구성되고 모듈화되며 콘텐츠는 해당 요소 (웹사이트, 사용자 가이드, C++ 참조, 튜토리얼 등) 및 콘텐츠 유형에 할당됩니다. 사용 가능한 정보가 매우 광범위하므로 일관된 참조 구조도 설정해야 합니다. 이 가이드의 목표는 종합적인 개요를 제공하고 사용자에게 필요에 따라 루트를 사용하는 방법을 명확하게 설명하는 것입니다. 또한 비물리학에 초점을 맞춘 간결한 소개가 제공됩니다.

4.) ROOT 문서 재작성

문서의 주요 부분, 특히 사용자 가이드는 DITA 접근 방식에 따라 다시 작성되었습니다. 구조화 및 작성 규칙은 향후 문서의 일관성을 보장하기 위해 스타일 가이드에 기록됩니다. 목표는 향후 ROOT팀이 ROOT 문서를 직접 확장하고 유지관리할 수 있도록 하는 것입니다.

예상 일정 (5개월):

1단계: 현재 ROOT 문서 분석(3주)

2단계: ROOT팀과 함께 소프트웨어 문서 작성 구조를 정의하는 방법 정의: 2주

3단계: ROOT 문서 재구성: 4주

4단계: ROOT 문서 재작성: 11주