어떻게 작동하는가

Harness Docs는 제품 문서를 하나의 워크스페이스 안에서 작성, 검토, 정리하고 배포하는 흐름을 제공합니다.

1. 문서 워크스페이스를 만든다

팀은 먼저 하나의 문서 워크스페이스를 만듭니다.

이 워크스페이스는 고객-facing 문서를 담는 GitHub docs 저장소와 연결됩니다.

2. 역할별 문서를 만든다

문서는 하나로 끝나지 않습니다. 제품을 이해하고 만들고 구현하려면 서로 다른 역할의 문서가 필요합니다.

먼저 아래를 정리합니다.

• 제품 요구사항
• 사용자 흐름
• 기술 설계
• 정책과 의사결정

Harness Docs는 이런 문서를 같은 공간 안에서 연결해 다룰 수 있게 합니다.

3. 문서 간 관계를 함께 관리한다

한 문서가 바뀌면 관련 문서도 영향을 받을 수 있습니다.

Harness Docs는 같은 워크스페이스 안에서 아래 문서를 함께 다루도록 돕습니다.

• 어떤 문서가 다른 문서와 연결돼 있는지
• 최근 변경으로 어떤 문서를 다시 봐야 하는지
• 어떤 문서가 최신 상태인지
• 어떤 문서가 아직 검토가 더 필요한지

4. 문서를 검토하고 보강한다

제품 문서는 역할마다 보는 관점이 다르기 때문에 검토가 중요합니다.

팀은 문서를 검토하면서 아래를 확인합니다.

• 다른 관련 문서와 기준이 맞는가
• 최근 변경이 반영되었는가
• 빠진 설명이나 어긋난 판단은 없는가

5. GitHub로 배포한다

문서가 준비되면 GitHub는 최종 배포 채널 역할을 합니다.

즉 GitHub는 공개 docs를 전달하는 경로이고, 문서 작업 맥락과 검토 이력은 앱 안에서 관리합니다.

6. 계속 업데이트한다

문서는 제품 변경과 함께 계속 고쳐야 합니다.

Harness Docs는 문서를 운영 대상처럼 다루는 흐름을 지향합니다.

• 최근 변경의 영향을 받은 문서 확인
• 다시 검토가 필요한 문서 확인
• 최신 상태인지 확인이 필요한 문서 확인
• 다시 배포할 준비 상태 확인

한 문장 요약

Harness Docs는 역할별 제품 문서 작성부터 검토, 배포, 업데이트까지 문서 운영 전체 흐름을 연결하는 제품입니다.