Skip to main content

Orchestration: docs-field-manual

개요: 실제 관리자·현장 UI를 보고 사용자 매뉴얼을 작성하거나 갱신합니다. 코드 템플릿이 아니라 문서 작업입니다. 글쓰기 기준과, 필요할 때 브라우저 수동 확인을 씁니다.

FieldValue
IDdocs-field-manual
Statusactive
Profile hint없음

적용 조건​

적용합니다.

  • 관리자 화면, 설치, 연동 절차를 사용자가 따라 할 수 있게 적을 때
  • 기존 매뉴얼 원본(Markdown 등)을 화면 기준으로 갱신할 때
  • PDF·정적 다운로드가 프로젝트 빌드에 이미 있을 때 그 산출물을 맞출 때

적용하지 않습니다.

  • Knowledge·ADR을 엔지니어링 기준으로 올릴 때 → archive-promote-pattern 또는 글쓰기 기준만
  • API 구현·계약 테스트만 하는 작업
  • 화면 없이 추측으로 매뉴얼을 쓰는 작업

입력과 미확정​

필요합니다.

  • 매뉴얼 원본 경로(예: 프로젝트의 doc/manual/...)
  • 대상 화면 URL 또는 로컬 기동 방법
  • 독자(현장 사용자, 설치 담당, E2E 담당 등)

미확정이면 확인합니다.

  • PDF 빌드 명령과 배포 경로
  • 캡처를 넣을지, 도식만 넣을지
  • 구 챕터를 삭제할지 유지할지

읽을 문서와 템플릿​

Path언제
docs/harness/context/writing-conventions.md문장·퇴고
docs/harness/workflows/acceptance.md문서 작업 확인 방식
docs/harness/tools/browser-manual.md화면 캡처·클릭 확인
docs/harness/entrypoints/cursor.mdCursor에서 브라우저 도구를 쓸 때

구현·테스트 템플릿은 읽지 않습니다. 매뉴얼 본문 구조는 대상 프로젝트의 기존 매뉴얼을 따릅니다.

작업 순서와 산출물​

  1. 독자와 목차 범위를 고정합니다. → 목차
  2. 화면을 열어 실제 라벨·경로·버튼을 확인합니다. → 메모 또는 캡처
  3. 원본 Markdown을 갱신합니다. 대화에서만 통하는 말은 빼습니다. → md
  4. 프로젝트에 PDF·에셋 빌드가 있으면 그 명령을 실행합니다. → PDF 또는 빌드 로그
  5. 글쓰기 퇴고 항목을 확인합니다. → 완료 보고

단일 에이전트 기본 경로​

작성, 화면 확인, 빌드는 한 에이전트가 합니다. 별도 Curator를 기본 실행하지 않습니다.

별도 에이전트​

조건역할
화면 구조·기동 방법을 모름Scout
중요한 사용자 절차의 누락 여부를 독립 확인할 때QA
매뉴얼 내용을 Knowledge로 승격할 때사용자 요청 후 Curator

통과 기준과 검증​

구분기준방법
정상목차의 절차를 화면과 대조해 따라 할 수 있음browser-manual
경계자주 발생하는 문제, 권한 없는 화면매뉴얼 절과 화면
실패빌드·다운로드 경로가 문서와 다름프로젝트 문서 빌드 명령

도구: browser-manual. playwright-e2e는 프로젝트에 해당 스위트가 있을 때만 씁니다.

실패·정보 부족 시​

  • 화면에 없으면 추측으로 쓰지 않습니다.
  • 운영 개인정보·실키가 캡처에 나오지 않게 합니다.
  • PDF 명령이 없으면 md만 갱신하고 빌드 한계를 적습니다.

완료 보고​

갱신한 파일, 확인한 화면, 빌드 명령과 결과, 빠진 챕터, 남은 캡처 작업을 적습니다.