사내 Wiki.js는 회사의 프로젝트 문서, 기술 문서, 업무 매뉴얼, 운영 가이드 등을 체계적으로 관리하기 위한 문서 공간입니다.
각 문서는 카테고리별로 분류되어 있으며, 필요한 문서를 빠르게 찾고 참고할 수 있도록 메뉴와 링크를 통해 연결되어 있습니다
사내 문서는 다음과 같은 기준으로 관리합니다.
- 프로젝트 문서
진행 중이거나 완료된 프로젝트의 기획, 설계, 개발, 테스트, 운영 관련 문서를 관리합니다.
예시 문서:
- 요구사항 정의서
- 화면 설계서
- 개발 산출물
- 테스트 결과
- 운영 이슈 및 조치 내역
- 고객 대응 가이드
- 기술 문서
개발, 서버, 데이터베이스, 배포, 보안, 장애 대응 등 기술 관련 내용을 정리합니다.
예시 문서:
- 서버 구성 방법
- 개발 환경 설정
- 배포 절차
- DB 설계 및 운영
- API 연동 가이드
- 장애 대응 매뉴얼
- 업무 문서
회사 내부 업무 처리 기준, 공통 양식, 운영 절차 등을 관리합니다.
예시 문서:
- 업무 처리 절차
- 사내 규정
- 공통 양식
- 문서 작성 기준
문서는 누구나 쉽게 이해할 수 있도록 명확하고 간결하게 작성합니다.
문서를 작성할 때는 다음 기준을 지켜주세요.
- 문서 제목은 내용을 쉽게 알 수 있도록 작성합니다.
- 관련 문서는 링크로 연결합니다.
- 변경 사항이 있을 경우 최신 내용으로 수정합니다.
- 프로젝트, 기술, 업무 문서는 정해진 카테고리에 맞게 등록합니다.
- 임시 메모보다는 추후 참고 가능한 형태로 정리합니다
- 새 문서를 생성한 후 해당 문서를 메뉴에 연결합니다.
문서 경로는 다음 규칙에 따라 생성합니다.
/{1레벨 카테고리명}/{폴더명}/{문서명}
예시:
/tech/qa/test-plan
/projects/chatbotmon/overview
- 메뉴는 2레벨로 구조로 구성합니다. 1레벨은 메뉴 카테고리이며, 2레벨은 실제 문서 링크입니다.
예를 들어 프로젝트, 기술문서, 업무문서와 같은 1레벨 카테고리용 대표 문서를 먼저 생성합니다.
/projects/home
/tech/home
그리고 각 대표 문서에는 해당 카테고리에 속하는 하위 문서 링크를 목록 형태로 작성합니다.