이 페이지에는 Google 시즌의 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) 형식: 시스템 통합자가 실행 중인 보고 도구 인스턴스에서 Flux 출력 데이터베이스를 업로드하고 처리하기 위해 취해야 하는 일련의 단계를 규정하는 방법 자료입니다.
작업 가이드 보고 도구에서 Flux 출력 데이터베이스 온보딩 및 처리
5)사용자 가이드
5.1) 타겟층 최종 사용자
5.2) 목표 최종 사용자가 보고 도구에 삽입된 다양한 기능과 이러한 기능을 사용해야 하는 방법을 이해하도록 지원합니다.
5.3) 형식 최종 사용자가 보고서 도구의 기능을 제대로 활용하기 위해 수행해야 하는 일련의 단계를 설명하는 방법 안내 자료입니다.
6) 개발 가이드
6.1) 타겟층 프로그래머
6.2) 목표 최종 사용자가 보고 도구에 삽입된 다양한 기능과 이러한 기능을 사용해야 하는 방법을 이해하도록 지원합니다.
6.3) 형식 다음을 설명하는 참조 도움말: a) 도구를 구성하는 주요 설계 요소 b) 위 요소의 기능 분해 c) 기능적으로 분해된 요소의 실행 요소 d) 도구의 소스 코드 / 라이브러리 구성 e) 지속적인 개선을 위한 장기 비전 및 방향 f) 다음으로 개선할 논리적 영역
그리고 사용자별 상황에 맞게 코드를 조정하는 방법을 설명하는 짧은 튜토리얼