공통 문서 템플릿
이 문서는 IT wiki에서 사용하는 공통 문서 템플릿에 대한 작성 가이드입니다. 주로 index와 같은 일반 문서에 적용하는 것을 목적으로 합니다.
1. 공통 템플릿의 목적
공통 템플릿은 다음을 목표로 합니다.
- 문서 구조의 일관성 유지
- 상·하위 문서 간 탐색을 쉽게 함
- 향후 문서 확장을 고려한 기본 골격 제공
이 템플릿은 모든 문서에 강제로 적용할 필요는 없습니다.
2. 적용 대상 문서
이 템플릿은 아래와 같은 문서에 사용하기 적합합니다.
-
카테고리 최상위 문서
-
예:
소프트웨어/개요,네트워크/개요 -
중간 분류(허브) 문서
-
예:
소프트웨어/응용 프로그램/개요,소프트웨어/개발/개요 - 여러 하위 문서를 묶는 개념 정리 문서
다음 유형의 문서에는 사용을 권장하지 않습니다.
- 문제 해결 문서
3. 공통 문서 템플릿
아래는 IT wiki에서 사용하는 공통 문서 템플릿입니다.
# {문서 제목}
## 개요
이 문서는 {주제}에 대해 기술한 문서입니다.
## 설명
(문서 설명)
## 하위 문서
- [하위 문서 1](./path)
- [하위 문서 2](./path)
## 관련 문서
- (필요 시 추가)
## 상위 문서로 돌아가기
- [{상위 문서 이름}](../index)
4. 각 문서 작성 기준
4.1 문서 제목
- 폴더 또는 분류의 이름과 동일하게 작성합니다.
4.2 개요
- 문서의 정체성과 역할을 한 문장으로 설명합니다.
- 가능한 한 아래 형식을 유지합니다.
이 문서는 ~에 대해 기술한 문서이다.
4.3 설명
- 문서의 본문 역할을 합니다.
- 초기에는
추후 추가 예정으로 두어도 무방합니다. 다만 이를 다른 작성자에게 떠넘기는 용도로 사용할 수는 없습니다. -
내용이 추가될 경우 다음과 같은 항목을 포함할 수 있습니다.
-
주제의 개념
- 범위 정의
- 간단한 배경 설명
4.4 하위 문서
- 현재 문서 아래에 위치한 하위 문서를 나열합니다.
- 폴더 구조와 동일한 순서를 유지하는 것을 권장합니다.
- 링크 텍스트는 문서 제목과 동일하게 작성합니다.
4.5 관련 문서
- 분류는 다르지만 개념적으로 연관된 문서를 연결합니다.
- 필수가 아니며, 적절한 문서가 있을 경우에만 작성합니다.
4.6 상위 문서로 돌아가기
- 현재 문서가 포함된 상위 분류 문서를 링크합니다.
- 대부분의 경우 분류 상에서 바로 위의 문서를 가리키게 됩니다.
5. 작성 시 유의사항
- 문서 길이보다 구조와 역할의 명확성을 우선합니다.
- 모든 내용을 한 번에 완성할 필요는 없습니다.