개발문서 - 컨플루언스(Confluence) 입문

회사에서 문서는 무형자산으로 시간이 갈수록 사업에 큰 영향을 미친다.

개발 행위는 지적자산으로 무형자산이 특히나 중요한 부분이라 생각한다.

 

문서가 아예 없는 회사도 경험하고,

문서 때문에 업무 하기 힘든 회사도 경험했지만,

역시 문서는 없어서는 안 되는 존재 같다.

 

이직하면서 회사에서 컴플루언스라는 tool을 처음 사용하게 되었는데 관련하여 정리해 본다.

 

- 컴플루언스 공식 가이드 문서 : https://www.atlassian.com/ko/software/confluence/resources/guides/get-started/overview#hosting-options

Confluence: 개요 | Atlassian

 

내가 경험해 본 사내 문서 관리는 아래와 같다.

 

[인트라넷 사용]

• 사내 인트라넷에서 접근 가능한 공유 폴더 존재 (NAS, Office 365, Google Drive을 쓰기도 함)
• Word, PPT, PDF, Excel로 업무 내용 저장 및 공유

[노션 사용]

• 문서 작성 + 각종 사이트 연동
• Notion 페이지 작성

컴플루언스도 같은 기능을 수행한다 보면 되겠다. 

문서를 보안이 되는 공통 공간에 저장, 수정, 검색을 쉽게 하고 문서작성을 빠르게 하도록 돕는 솔루션

 

대표적으로 쓸만한 기능들을 소개한다.

[대표 특징]

- Space라는 권한 설정이 가능한 최상위 공간에서 문서를 작성할 수 있다.

첫 페이지

- Space안에 Page 단위로 문서를 작성할 수 있다.

- 1개 Page에 관해서 권한 설정이 가능하다. 

- Page는 트리 구조로 관리할 수 있고 드래그로 이동 가능하다. 

스페이스 좌측 페이지

- 다양한 익스텐션을 제공한다. (/ 누르면 확인 가능)

- 페이지 검색 기능을 고급으로 수행할 수 있다. 

고급 검색 페이지

- 우측 상단? 아이콘을 누르면 키보드 단축키를 확인할 수 있다.

- 노션처럼 문서 포맷을 지켜면서 빠르게 작성할 수 있다. 

단축키

- 100개 넘는 템플릿 사용할 수 있고, Custom 할 수 있다. 

- Jira랑 연동할 수 있다. 

(프로젝트 진행사항을 문서에 같이 표시할 수 있다.)

 

1시간 사용해 보고 느낀 점은 노션이랑 비슷하다. (단, Jira 연동이랑 매크로 기능을 좀 더 살펴봐야 할 듯하다)

 

[개발문서 작성 포맷]

A. 프로그램 설치 가이드라면  

• 프로그램에 대한 간략한 소개
• 프로그램을 설치하기 위해 필요한 최소 사양
• 프로그램 설치 방법
• 프로그램 실행 방법

 

B. API 문서라면

- Stripe API 문서 참고 (여러 테크니컬 라이터들이 추천하는 사이트).