본문으로 건너뛰기

Slack 문서화 요청 템플릿

목적

Slack에서 나온 질문, 답변, 운영 기준, 이슈 해결 내용을 Team Library용 문서로 바꿀 때 요청 형식을 통일하기 위한 템플릿입니다.

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

  • 문서 유형 판단
  • 제목 제안
  • 문서 경로 제안
  • markdown 초안 작성
  • 확인 포인트 정리

기본 요청 템플릿

[문서화 요청]
- 원문: (Slack 대화/답변 붙여넣기)
- 문서 유형: 가이드 / 체크리스트 / FAQ / 트러블슈팅 / 정책 / 미정
- 대상 서비스:
- 목적:
- 포함할 핵심 포인트:
- 제외할 내용:
- 공개 범위: 내부 전용 / 일부 공유 가능 / 미정

가장 간단한 요청 예시

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

이 슬랙 답변 Team Library 문서로 바꿔줘.
이 이슈 해결 내용 트러블슈팅 문서로 정리해줘.
이 운영 기준 가이드 문서로 만들어줘.

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

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

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

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

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

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

문서 유형을 모르겠을 때

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

예:

[문서화 요청]
- 원문: (대화 붙여넣기)
- 문서 유형: 미정
- 대상 서비스: CRM
- 목적: 나중에 재사용할 수 있게 정리

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

  • docs
  • blog
  • 체크리스트
  • FAQ
  • 트러블슈팅

OpenClaw가 반환하면 좋은 결과물

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

  1. 문서 유형 제안
  2. 제목 제안
  3. 저장 경로 제안
  4. markdown 초안
  5. 컨펌 필요 사항

컨펌 전 확인 항목

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

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

운영 팁

  • 원문이 길면 핵심 부분만 추려도 됩니다.
  • Slack 스레드 전체를 붙여넣기보다 결론이 드러나는 메시지를 중심으로 주는 편이 좋습니다.
  • 반복 질문은 한 번 문서화해 두면 이후 링크로 대응하기 쉬워집니다.

한 줄 요청 버전

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

이 슬랙 답변 Team Library용 문서 초안으로 정리해줘.
이 대화 내용 docs로 넣을 수 있게 md로 바꿔줘.
이 내용 컨펌용 초안으로 먼저 만들어줘.