이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- moja Global
- 테크니컬 라이터:
- 앤서니
- 프로젝트 이름:
- 보고 도구 코드 문서
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
Moja Global 조직을 위해 보고 도구를 문서화할 기회를 감안하여 다양한 대상이 다양한 목적을 달성하는 데 활용할 수 있는 6가지 유형의 문서를 개발할 것을 제안합니다. 내용은 아래에 요약되어 있습니다.
1) 환경 설정 가이드
1.1) 타겟 잠재고객 시스템 엔지니어
1.2) 목표 시스템 엔지니어가 보고 도구를 위한 로컬 빌드 및 실행 환경을 설정하도록 지원합니다.
1.3) 시스템 엔지니어가 보고 도구 빌드 및 실행에 도움이 되는 환경을 설정하기 위해 수행해야 하는 일련의 순차적 단계를 규정하는 방법 문서
2)빌드 가이드
2.1) 타겟 잠재고객 시스템 엔지니어
2.2) 목표 시스템 엔지니어가 소스 코드에서 보고 도구 구성요소를 만들 수 있도록 지원
2.3) 형식 시스템 엔지니어가 보고 도구의 소스 코드를 가져와 컴파일하기 위해 수행해야 하는 일련의 순차적 단계를 규정하는 방법 문서
3)설치 가이드
3.1) 타겟 잠재고객 시스템 엔지니어
3.2) 목표 시스템 엔지니어가 새롭게 빌드된 보고 도구 구성요소를 설치하도록 지원
3.3) 시스템 엔지니어가 새로 설정한 환경에 보고 도구를 배포하기 위해 수행해야 하는 일련의 순차적 단계를 규정하는 방법 도움말의 형식 을 지정합니다.
4)작동 가이드
4.1) 공유 대상 그룹 시스템 통합업체
4.2) 목표 시스템 엔지니어가 새로 설치된 보고 도구 인스턴스를 실행하도록 지원
4.3) 시스템 통합자가 실행 중인 보고 도구 인스턴스에서 플럭스 출력 데이터베이스를 업로드하고 처리하기 위해 수행해야 하는 일련의 순차적 단계를 규정하는 안내 자료
작업 가이드 보고 도구에서 플럭스 출력 데이터베이스 온보딩 및 처리
5)사용자 가이드
5.1) 타겟층 최종 사용자
5.2) 목표 '보고서 도구에 포함된 다양한 기능'과 이 기능을 사용하는 방법을 '최종 사용자'가 이해하는 데 도움이 됩니다.
5.3) 형식 '최종 사용자'가 보고 도구의 기능을 적절하게 활용하기 위해 취해야 하는 순차적 단계를 규정하는 방법 도움말
6) 개발 가이드
6.1) 타겟층 프로그래머
6.2) 목표 '보고 도구'에 포함된 다양한 기능과 이 기능을 사용하는 방법을 '최종 사용자'가 이해하는 데 도움이 됩니다.
6.3) 형식 다음을 설명하는 참조 자료
사용자별 상황에 맞게 코드를 조정하는 방법을 설명하는 짧은 튜토리얼