본문으로 건너뛰기

Slack 문서화 요청 템플릿

목적

이 문서는 Slack에서 들어오는 요청사항을 Team Library 문서 초안으로 바꿀 때, 누가 봐도 같은 방식으로 요청하고 같은 품질로 정리할 수 있게 만드는 공통 템플릿입니다.

기존에는 "이 슬랙 답변 문서화해줘"처럼 짧게 요청해도 작업은 가능했지만, 채널마다 요청 성격이 다르고 문서 목적도 달라질 수 있어서 채널 기준으로 요청을 정리하는 방식이 더 실무적으로 맞습니다.

이 템플릿을 사용하면 OpenClaw가 아래 작업을 더 안정적으로 수행할 수 있습니다.

  • 문서 유형 판단
  • 제목 제안
  • 저장 경로 제안
  • markdown 초안 작성
  • 확인 포인트 정리
  • 게시 전 검토 포인트 정리

적용 대상 Slack 채널

현재 기준으로 아래 채널 요청을 Team Library 문서화 대상 채널로 봅니다.

  • C0APEQAS9CH
  • C0ANYEV1U13
  • C0AP9JTM754

참고: 지금 문서는 채널 ID 기준으로 먼저 정리했습니다. 나중에 채널 성격이 명확해지면 채널명, 주제, 대표 요청 유형을 함께 적어두는 것을 권장합니다.

이 문서의 기본 원칙

  • Slack 원문을 그대로 게시하지 않습니다.
  • 요청 내용을 문서 목적에 맞게 구조화합니다.
  • 민감한 정보는 정리 과정에서 제외하거나 수정합니다.
  • Team Library 반영 전에는 사람이 최종 확인합니다.
  • 가능하면 "어느 채널에서 나온 요청인지"를 같이 남깁니다.

채널 기준으로 요청 정리하기

문서화 요청을 받을 때는 최소한 아래 기준으로 정리하는 것을 권장합니다.

  • 어떤 채널에서 나온 요청인지
  • 어떤 문제를 해결하려는 요청인지
  • 운영 가이드인지, 체크리스트인지, 트러블슈팅인지
  • 팀이 나중에 다시 찾아볼 가치가 있는지
  • 특정 1회성 대화인지, 반복 가능한 지식인지

기본 요청 템플릿

[문서화 요청]
- Slack 채널: C0APEQAS9CH / C0ANYEV1U13 / C0AP9JTM754 / 기타
- 원문: (Slack 대화/답변/요청 내용 붙여넣기)
- 요청 배경: 왜 이 내용을 문서화하려는지
- 문서 유형: 가이드 / 체크리스트 / FAQ / 트러블슈팅 / 정책 / 워크플로우 / 미정
- 대상 서비스:
- 목적:
- 포함할 핵심 포인트:
- 제외할 내용:
- 공개 범위: 내부 전용 / 일부 공유 가능 / 미정

가장 간단한 요청 예시

아주 짧게 요청해도 됩니다.

C0APEQAS9CH 채널에서 나온 이 요청, Team Library 문서로 정리해줘.
C0ANYEV1U13 채널에서 반복되는 질문인데 FAQ나 가이드로 바꿔줘.
C0AP9JTM754 채널에서 나온 이슈 해결 내용을 트러블슈팅 문서로 정리해줘.

채널별로 정리할 때 권장하는 방식

1. 반복 질문이 많은 채널

이런 채널은 아래 문서 유형이 잘 맞습니다.

  • FAQ
  • 운영 가이드
  • 체크리스트

정리 포인트:

  • 반복 질문이 무엇인지
  • 답변의 공통 기준이 무엇인지
  • 매번 빠지는 확인 항목이 무엇인지

2. 작업 요청이 많은 채널

이런 채널은 아래 문서 유형이 잘 맞습니다.

  • 요청 템플릿
  • 작업 접수 기준
  • 사전 확인 체크리스트
  • 운영 워크플로우

정리 포인트:

  • 어떤 정보가 누락되기 쉬운지
  • 요청자가 미리 적어야 하는 항목이 무엇인지
  • 작업 전/후 확인 포인트가 무엇인지

3. 장애/이슈 대응이 많은 채널

이런 채널은 아래 문서 유형이 잘 맞습니다.

  • 트러블슈팅
  • 장애 대응 절차
  • 원인/해결 사례 모음

정리 포인트:

  • 증상
  • 원인
  • 해결 방법
  • 재발 방지 포인트
  • 확인 명령 또는 점검 절차

채널별 요청 정리 시트 예시

아래처럼 채널별 문서화 기준을 누적 관리하면 좋습니다.

C0APEQAS9CH

  • 채널 성격: (추가 필요)
  • 자주 나오는 요청: (추가 필요)
  • 추천 문서 유형: 가이드 / 체크리스트 / FAQ / 트러블슈팅 중 선택
  • 우선 문서화 대상: (추가 필요)

C0ANYEV1U13

  • 채널 성격: (추가 필요)
  • 자주 나오는 요청: (추가 필요)
  • 추천 문서 유형: 가이드 / 체크리스트 / FAQ / 트러블슈팅 중 선택
  • 우선 문서화 대상: (추가 필요)

C0AP9JTM754

  • 채널 성격: (추가 필요)
  • 자주 나오는 요청: (추가 필요)
  • 추천 문서 유형: 가이드 / 체크리스트 / FAQ / 트러블슈팅 중 선택
  • 우선 문서화 대상: (추가 필요)

권장 요청 예시 1: 운영 가이드

[문서화 요청]
- Slack 채널: C0APEQAS9CH
- 원문: 공지사항 등록할 때 노출 기간, 상단 고정 여부, 링크 연결 여부를 먼저 확인해야 합니다. 등록 후에는 PC/모바일에서 다 확인해 주세요.
- 요청 배경: 같은 설명이 반복되고 있어 운영 기준으로 남기기 위함
- 문서 유형: 가이드
- 대상 서비스: 홈페이지
- 목적: 공지사항 등록 기준 통일
- 포함할 핵심 포인트: 사전 확인 항목, 등록 절차, QA 항목
- 제외할 내용: 담당자 개인 메모
- 공개 범위: 내부 전용

권장 요청 예시 2: 트러블슈팅

[문서화 요청]
- Slack 채널: C0AP9JTM754
- 원문: team-library.biny.cloud는 DNS는 붙어 있었는데 nginx에 server_name이 없어서 HTTP 404가 났고, HTTPS는 certbot 전이라 다른 서비스로 빠졌습니다. nginx 설정 후 certbot으로 해결했습니다.
- 요청 배경: 동일한 배포 이슈 재발 시 빠른 대응을 위해 정리
- 문서 유형: 트러블슈팅
- 대상 서비스: Team Library
- 목적: 같은 장애 재발 시 빠르게 대응
- 포함할 핵심 포인트: 증상, 원인, 해결 절차, 확인 방법
- 제외할 내용: 작업 중 오타나 중간 시행착오 전체 로그
- 공개 범위: 내부 전용

권장 요청 예시 3: 체크리스트

[문서화 요청]
- Slack 채널: C0ANYEV1U13
- 원문: 배너 수정 요청 받을 때 문구, 링크, 노출 기간, 이미지 사이즈, 모바일 대응 여부를 먼저 받아야 함
- 요청 배경: 요청 누락으로 재작업이 반복됨
- 문서 유형: 체크리스트
- 대상 서비스: 홈페이지
- 목적: 배너 요청 접수 누락 방지
- 포함할 핵심 포인트: 요청 전 확인 항목, 작업 전 확인 항목, 배포 후 확인 항목
- 제외할 내용: 특정 요청자의 사례 설명
- 공개 범위: 내부 전용

문서 유형을 모르겠을 때

문서 유형을 정확히 모르겠다면 미정으로 요청해도 됩니다.

예:

[문서화 요청]
- Slack 채널: C0APEQAS9CH
- 원문: (대화 붙여넣기)
- 요청 배경: 반복되는 내용이라 정리 필요
- 문서 유형: 미정
- 대상 서비스: CRM
- 목적: 나중에 재사용할 수 있게 정리

이 경우 OpenClaw가 아래 중 하나를 제안합니다.

  • docs
  • blog
  • 체크리스트
  • FAQ
  • 트러블슈팅
  • 워크플로우

OpenClaw가 반환하면 좋은 결과물

문서화 요청에 대해 OpenClaw는 보통 아래 형식으로 응답하면 좋습니다.

  1. 문서 유형 제안
  2. 제목 제안
  3. 저장 경로 제안
  4. Markdown 초안
  5. 확인이 필요한 사항
  6. 민감정보/검토 포인트

컨펌 전 확인 항목

문서를 Team Library에 반영하기 전에 아래를 확인합니다.

  • 민감한 값, 계정 정보, 내부 식별자가 없는지
  • 너무 대화체로 남아 있지 않은지
  • 실제 운영 기준과 맞는지
  • 문서 제목과 카테고리가 적절한지
  • 중복 문서가 아닌지
  • 해당 채널의 맥락 없이 읽어도 이해 가능한지

운영 팁

  • 원문이 길면 핵심 메시지와 결론 위주로 추려도 됩니다.
  • Slack 스레드 전체를 붙이기보다, 결론이 드러나는 메시지를 중심으로 주는 편이 좋습니다.
  • 같은 채널에서 반복되는 요청은 개별 문서보다 공통 가이드 문서가 더 효율적일 수 있습니다.
  • 채널별 대표 요청 유형을 한 번 정리해두면 이후 문서화 속도가 빨라집니다.

다음에 같이 정리하면 좋은 것

이 문서를 더 실무적으로 만들려면 아래 정보를 추가하는 것이 좋습니다.

  • 각 채널의 실제 채널명
  • 채널 목적
  • 자주 나오는 요청 유형
  • 문서화 우선순위가 높은 요청 목록
  • 채널별 추천 문서 카테고리

한 줄 요청 버전

빠르게 요청할 때는 아래처럼 보내도 충분합니다.

C0APEQAS9CH 채널 요청인데 Team Library용 문서 초안으로 정리해줘.
C0ANYEV1U13 채널의 반복 요청을 docs로 넣을 수 있게 md로 바꿔줘.
C0AP9JTM754 채널 이슈 대응 내용을 트러블슈팅 초안으로 만들어줘.