☰ Categories

Categories

Comprehensive User Manual Creation for Multiple Modules

a User Guide Specialist. You are tasked with creating a comprehensive user manual for all modules within a project, focusing on the end-user experienc

CategoryDevelopment › Technical writing
TagsDraftingReformattingDeveloperCode
Prompt
Act as a User Guide Specialist. You are tasked with creating a comprehensive user manual for all modules within a project, focusing on the end-user experience.

Your task is to:
- Analyze the source code of each module to understand their functionality, specifically the controller, view, and model components.
- Translate technical operations into user-friendly instructions for each module.
- Develop a step-by-step guide on how users can interact with each module's features without needing to understand the underlying code.

You will:
- Provide clear explanations of each feature within every module and its purpose.
- Use simple language suitable for non-technical users.
- Include examples of common tasks that can be performed using the modules.
- Allocate placeholders for images to be added later in a notebook for visual guidance.
- Consolidate repetitive features like filter and grid usage into separate pages to avoid redundancy in each module's section.

Rules:
- Avoid technical jargon unless necessary, and explain it when used.
- Ensure the guide is accessible to users without a technical background.
- Ensure consistency in how features and modules are documented across the guide.

What this prompt does

This role turns multiple modules' functionality into an end-user guide. It asks for image placeholders, separate pages for repeated features, and avoidance or explanation of technical jargon.

Model comparison

ChatGPT is strongest because it delivers a usable manual, though it assumes a few features. Gemini only reports completion without the manual, while [C] provides no answer.

ChatGPTTop overall
41/ 50

＋ Turns known features into clear steps and examples.

－ Assumes some unverified features such as filters and rejection.

Gemini
15/ 50

＋ Clearly identifies the audience and intended structure.

－ Provides no manual and relies on an unverifiable file.

CriterionChatGPTGeminiLeader
Instruction following92ChatGPT +350%
Accuracy72ChatGPT +250%
Specificity83ChatGPT +167%
Structure95ChatGPT +80%
Right length83ChatGPT +167%

Scored 1–10 by gpt-5.6-sol with model names hidden (2026-09-25). This is an AI review, not a measurement.

Read full answers

We gave three models the same input and copied their answers unedited. Each ran in its CLI (an agent harness), and answers in the ChatGPT or Claude apps or on the web may differ. Outputs are in Korean.

Input used
[Pasted material]
다음은 사내 인사관리 시스템의 '휴가신청' 모듈 소스코드 일부입니다.

// LeaveRequestController.php
class LeaveRequestController extends Controller {
    public function store(Request $request) {
        $leave = LeaveRequest::create([...]);
        // 팀장에게 승인 알림 발송
        return redirect('/leave/list');
    }
    public function approve($id) { ... }
}

// LeaveRequest.php (Model)
class LeaveRequest extends Model {
    protected $fillable = ['user_id','start_date','end_date','reason','status'];
}

// resources/views/leave/create.blade.php
<form action="/leave" method="POST">...</form>

이 외에 '전자결재', '근태관리' 모듈도 있지만 우선 이 휴가신청 모듈부터 매뉴얼을 만들어주세요. 사용자는 전산에 익숙하지 않은 50대 인사팀 직원입니다.
gpt-5.6-luna (codex CLI · 에이전트 하네스) · Run on 2026-09-24

휴가신청 모듈 사용자 매뉴얼

1. 모듈 소개

휴가신청 모듈은 직원이 휴가를 신청하고, 팀장이 신청 내용을 확인하여 승인하거나 처리하는 기능입니다.

휴가신청이 등록되면 팀장에게 승인 알림이 발송됩니다. 신청이 완료된 후에는 휴가 목록 화면에서 신청 내역을 확인할 수 있습니다.

[이미지 placeholder: 휴가신청 메뉴 위치]

2. 주요 기능

기능 설명
휴가 신청 휴가 시작일, 종료일, 사유를 입력하여 신청
신청 내역 확인 내가 신청한 휴가의 등록 내용을 확인
승인 알림 휴가 신청이 등록되면 팀장에게 알림 발송
휴가 승인 팀장이 신청 내용을 확인하고 승인 처리
상태 확인 신청이 승인되었는지 또는 처리 중인지 확인

3. 휴가 신청하기

3.1 휴가신청 화면 열기

  1. 인사관리 시스템에 로그인합니다.
  2. 메뉴에서 휴가신청을 선택합니다.
  3. 휴가 신청 또는 신청하기 버튼을 누릅니다.

[이미지 placeholder: 휴가신청 메뉴와 신청 버튼]

3.2 신청 내용 입력

신청 화면에서 다음 내용을 입력합니다.

  • 휴가 시작일: 휴가를 시작하는 날짜
  • 휴가 종료일: 휴가가 끝나는 날짜
  • 휴가 사유: 휴가를 사용하는 이유
  • 신청자: 로그인한 사용자 정보가 자동으로 지정될 수 있음

예시:

항목 입력 예시
휴가 시작일 2026년 10월 12일
휴가 종료일 2026년 10월 14일
휴가 사유 가족 행사 참석

[이미지 placeholder: 휴가 신청 입력 화면]

3.3 신청 내용 확인 및 제출

  1. 시작일과 종료일이 정확한지 확인합니다.
  2. 휴가 사유를 입력합니다.
  3. 날짜를 잘못 입력하지 않았는지 다시 확인합니다.
  4. 신청, 저장, 또는 제출 버튼을 누릅니다.

신청이 정상적으로 등록되면 휴가 목록 화면으로 이동합니다.

[이미지 placeholder: 휴가 신청 제출 버튼]

4. 신청 후 확인하기

신청을 완료하면 휴가 목록 화면에서 신청 내역을 확인할 수 있습니다.

확인할 수 있는 주요 내용은 다음과 같습니다.

  • 신청한 휴가 기간
  • 휴가 사유
  • 신청 처리 상태
  • 승인 여부

신청 직후에는 팀장의 확인이 필요하므로 처리 중, 승인 대기, 또는 이와 비슷한 상태로 표시될 수 있습니다.

[이미지 placeholder: 휴가 신청 목록 화면]

상태의 의미

상태 의미
승인 대기 팀장이 아직 확인하지 않은 상태
승인 팀장이 휴가를 허가한 상태
반려 팀장이 사유를 확인한 후 승인하지 않은 상태
취소 신청이 취소된 상태

현재 제공된 소스에는 status라는 상태 정보가 포함되어 있습니다. 실제 화면에 표시되는 상태 이름은 회사 시스템 설정에 따라 다를 수 있습니다.

5. 팀장의 휴가 승인 처리

팀장 권한이 있는 사용자는 직원의 휴가 신청을 확인하고 승인할 수 있습니다.

5.1 신청 내역 확인

  1. 휴가신청 메뉴를 엽니다.
  2. 직원의 신청 목록을 확인합니다.
  3. 승인할 신청 항목을 선택합니다.
  4. 신청자의 휴가 기간과 사유를 확인합니다.

[이미지 placeholder: 팀장용 휴가 신청 목록]

5.2 휴가 승인하기

  1. 신청 내용을 확인합니다.
  2. 문제가 없으면 승인 버튼을 누릅니다.
  3. 승인 여부를 다시 묻는 화면이 나타나면 확인합니다.
  4. 신청 상태가 승인으로 변경되었는지 확인합니다.

휴가 신청이 등록되면 팀장에게 승인 알림이 발송되도록 되어 있습니다.

[이미지 placeholder: 휴가 승인 버튼]

5.3 승인 전 확인할 사항

승인하기 전에 다음 내용을 확인합니다.

  • 휴가 시작일과 종료일이 적절한지
  • 다른 직원의 휴가와 일정이 겹치지 않는지
  • 휴가 사유가 입력되어 있는지
  • 신청자가 실제로 해당 휴가를 사용할 수 있는지

6. 자주 하는 업무 예시

예시 1: 개인 휴가 신청

  1. 휴가신청 메뉴를 선택합니다.
  2. 시작일과 종료일을 입력합니다.
  3. 사유에 “개인 사정”을 입력합니다.
  4. 내용을 확인한 후 신청합니다.
  5. 목록에서 승인 대기 상태인지 확인합니다.

예시 2: 병가 신청

  1. 휴가 신청 화면을 엽니다.
  2. 병가를 사용할 날짜를 입력합니다.
  3. 사유에 “병원 진료” 또는 “몸이 좋지 않아 휴식”이라고 입력합니다.
  4. 신청 버튼을 누릅니다.
  5. 팀장의 승인 여부를 확인합니다.

예시 3: 팀장이 직원의 신청 승인

  1. 휴가 목록에서 승인 대기 중인 신청을 찾습니다.
  2. 직원명, 날짜, 사유를 확인합니다.
  3. 이상이 없으면 승인 버튼을 누릅니다.
  4. 상태가 승인으로 바뀌었는지 확인합니다.

7. 휴가 목록 사용 안내

휴가 신청 건수가 많을 경우 목록에서 원하는 신청을 찾기 어려울 수 있습니다. 이때 목록의 검색 또는 필터 기능을 사용할 수 있습니다.

필터란?

필터는 많은 자료 중에서 조건에 맞는 항목만 골라 보는 기능입니다.

예를 들어 다음과 같이 조회할 수 있습니다.

  • 승인 대기 중인 신청만 보기
  • 특정 직원의 신청만 보기
  • 특정 기간의 휴가만 보기
  • 승인된 신청만 보기

[이미지 placeholder: 휴가 목록 필터 영역]

필터 사용 방법

  1. 목록 화면에서 조건을 선택합니다.
  2. 조회 기간이나 상태를 입력합니다.
  3. 검색, 조회, 또는 적용 버튼을 누릅니다.
  4. 조건에 맞는 신청 목록을 확인합니다.

필터를 해제하려면 초기화 또는 전체 보기 버튼을 누릅니다.

8. 목록 화면과 표 사용 안내

휴가 목록은 보통 표 형태로 표시됩니다. 표의 각 줄은 하나의 휴가 신청을 의미합니다.

예시:

신청자 시작일 종료일 사유 상태
김민수 10월 12일 10월 14일 가족 행사 승인 대기
이영희 10월 20일 10월 21일 병원 진료 승인

표의 제목을 누르면 날짜순, 이름순 등으로 정렬할 수 있는 경우도 있습니다.

[이미지 placeholder: 휴가 신청 목록 표 설명]

9. 입력 시 주의사항

  • 시작일과 종료일을 정확하게 입력합니다.
  • 종료일이 시작일보다 빠르지 않도록 합니다.
  • 휴가 사유를 알아보기 쉽게 입력합니다.
  • 신청 버튼을 누른 후 목록 화면으로 이동했는지 확인합니다.
  • 같은 휴가를 여러 번 신청하지 않도록 주의합니다.
  • 승인 전에는 휴가가 최종 확정된 것으로 보지 않는 것이 좋습니다.

10. 문제가 발생했을 때

신청 후 목록으로 이동하지 않는 경우

  • 입력하지 않은 필수 항목이 있는지 확인합니다.
  • 날짜 형식이 올바른지 확인합니다.
  • 화면을 새로 고친 후 다시 확인합니다.
  • 계속 문제가 발생하면 인사팀 또는 시스템 담당자에게 문의합니다.

신청 상태가 계속 승인 대기인 경우

팀장이 아직 신청 내용을 확인하지 않았을 수 있습니다. 팀장에게 승인 요청이 전달되었는지 확인합니다.

잘못 신청한 경우

현재 제공된 소스만으로는 신청 수정 또는 취소 기능의 존재 여부를 확인할 수 없습니다. 수정이나 취소 버튼이 보이지 않으면 인사팀 또는 시스템 담당자에게 문의해야 합니다.

11. 빠른 사용 요약

직원

  1. 휴가신청 메뉴 선택
  2. 휴가 날짜와 사유 입력
  3. 신청 버튼 선택
  4. 목록에서 처리 상태 확인

팀장

  1. 휴가 신청 목록 확인
  2. 신청자, 날짜, 사유 검토
  3. 승인 버튼 선택
  4. 승인 상태 확인

[이미지 placeholder: 휴가신청 전체 절차 요약 이미지]

참고로 현재 제공된 소스에는 휴가 신청 등록, 팀장 승인, 신청 목록 이동, 신청자·기간·사유·상태 정보가 확인됩니다. 실제 화면의 버튼 이름, 반려·취소·수정 기능은 완성된 화면과 추가 소스 확인 후 보완할 수 있습니다.

More in this category

Act as an FTTH Telecommunications Expert
Architect Guide for Programmers
Beginner's Guide to Building and Deploying LLMs
Building a Comprehensive Programming Team
CLAUDE.md Assembly