1 About Readers and ManualsTypes of

1 About Readers and Manuals

Types of Manuals

Before starting to write, you’ll need to decide on the type of manual. Each type has a different purpose and different objectives. To decide which to write, you’ll need to look globally at your organization or program to see what documentation already exists, how your manual will fit in, and what purpose it will serve.

Will your readers use the document to learn how to operate a new piece of equipment? If so, perhaps you should write a tutorial. Or, if they already know how to operate it, but only need something to refer back to occasionally, perhaps you should write a reference manual. You may need to write one manual, or perhaps a series of manuals.

Documentation Hierarchy

Most organization manuals fit within a documentation hierarchy with legislation and organization-wide policy manuals at the top, and procedure and technical manuals at the bottom. Manuals at the top of the hierarchy set parameters that lower-level manuals must comply with. It’s useful to sketch the hierarchy for your organization’s manuals so that everyone understands the role of the new manual and how it will fit in. Figure 1-1 shows a sample documentation hierarchy. Make sure that everyone agrees on which type you’re writing.

Figure 1-1: Sample documentation hierarchy
Figure 1-1: Sample documentation hierarchy

Policy manuals – document the rules governing an organization. Policies can be set out at the board, organization, department, work group, or other levels. They can be short and general, or long and detailed. Most organizations have, or would benefit from, an organization-wide policy manual. It’s usually the highest manual in the document hierarchy, since other manuals, such as department procedure manuals, typically must comply with those policies. In smaller organizations, policies and procedures are often found in the same manual. Policy manuals are usually organized by business function or department.

Procedure manuals – document how things are done, such as processing an invoice, and often serve to implement policies. Step-by-step procedures and flow diagrams are frequently used. The reader is usually assumed to be familiar with the topic, but has not performed the procedure often enough to have memorized it. Procedure manuals are usually organized by work task, with procedures grouped according to business function or by department.

Standards manuals – set standards for products, services, or other work activities. They are common in engineering, manufacturing, and construction where they are used to specify materials or manufacturing standards. But standards are also found in procedure manuals to set out how frequently, how fast, or how accurately things will be done. For example, they may state that “all invoices will be paid within 30 days.” Standards manuals can be organized in various ways, such as by material type, system, or job task.

Guidebooks – give readers more latitude than policy and procedure manuals. They contain guidelines for dealing with different situations. Guidelines are usually non-mandatory suggestions rather than strict rules or clearly defined procedures. Sometimes they simply establish the bounds within which employees may act at their own discretion. Guidebooks are usually organized by work task, business function, or department.

User manuals – contain instructions for installing and using software or hardware and should be organized around user tasks. They don’t describe the software in the detailed way that a reference manual might—they describe how the software is used, usually with lots of step-by-step procedures. The user manual is the primary manual for all users, but particularly for novices.

Reference manuals – usually provide detailed information on hardware or software organized for quick reference. They may also include other types of information, such as code lists or lists of names and contact information. For software, they often systematically describe each field, in each dialogue box, in each menu. Unlike user manuals, they are not organized around user tasks, but may be alphabetized by keyword or sequenced according to the spatial arrangement of the software interface. Readers are assumed to be familiar with the software but need quick information on some aspect of the system. This is not the kind of manual to give to a novice.

Training manuals – are designed to teach readers something new. They may be self-paced (readers do the tutorials at their own rate) or they may be designed for use with a training course. They seldom try to teach everything, but just try to provide a basic foundation upon which readers can build. Training manuals usually start with basic skills and progress to more advanced skills as readers gain experience and confidence. Once the software or procedures are learned, the user manual or reference manual is typically used.

Operator manuals – provide detailed instructions for operating instruments or equipment and may include installation and troubleshooting instructions. If it’s complex equipment, separate installation and maintenance manuals may be produced. The reader is often an engineer or a technician. Similar to software user manuals, operator manuals are usually organized around work tasks.

Service manuals – are used by service technicians or engineers to perform routine maintenance or to troubleshoot and fix problems or breakdowns. Service manuals often describe the theory of how the equipment works and operating principles, and instructions on how to disassemble and reassemble components. They are often organized by system, such as “electrical system,” or by component.

Field guides – are designed for use away from a desk, often outdoors. They are commonly used to help identify plants or animals, or to describe field tests. Field guides are often small enough to fit into a pocket, and are sometimes printed on waterproof paper. They are often organized alphabetically by keyword for quick reference, or by work task (such as a sampling procedure).

Combination Manuals

Often two or more types of manuals are combined:

policy and procedure
standards and guidelines
operations and service
user and reference
There is nothing wrong with combining different types of information into a single manual if it serves the purpose and intended audience of the manual. For example, many organization manuals combine policies, procedures, standards, and guidelines. If it’s important that the intended reader have ready access to these different types of information, then consider combining them. These manuals are sometimes called employee handbooks or simply policy and procedure manuals, reflecting the mixture of information types.

Another consideration is that when they are using a manual, most people are simply looking for the information needed to get their jobs done. Typically they don’t care what type of information it is (such as policy, procedure, standard, or guideline), nor can they easily distinguish between the types.

It’s also difficult for the manual writer to distinguish between the information types. For example, if the president and the director of finance must review and sign off on legal contracts, is this a policy or is it part of the procedure? Similar problems will plague the writer who tries to separate information by type.

In some circumstances, however, it is appropriate to separate the types of information. For example, you may provide a manual containing only policy to the Board of Directors or to senior management since this is the level of information they will be interested in, while providing a manual containing both policies and procedures to staff.


Copyright © 2006 Duncan Kent & Associates Ltd. Top

ผลลัพธ์ (ไทย) 1:

1เกี่ยวกับตัวอ่านและคู่มือชนิดของคู่มือก่อนที่จะเริ่มเขียน คุณจะต้องตัดสินใจชนิดของคู่มือ แต่ละชนิดมีวัตถุประสงค์แตกต่างกันและวัตถุประสงค์ที่แตกต่างกัน การตัดสินใจที่จะเขียน คุณจะต้องมององค์กรทั่วโลก หรือโปรแกรมดูเอกสารอะไรแล้ว อยู่ วิธีของคุณด้วยตนเองจะพอดีกับ และวัตถุประสงค์อะไร จึงจะให้บริการจะอ่านของคุณใช้เอกสารการเรียนรู้วิธีการใช้งานอุปกรณ์ชิ้นใหม่ ถ้าเป็นเช่นนั้น ทีคุณควรเขียนกวดวิชา หรือ ถ้าพวกเขารู้วิธีการใช้งานได้อยู่แล้ว แต่ต้องให้ถึงกลับบางครั้ง บางทีคุณควรเขียนคู่มืออ้างอิง คุณอาจจำเป็นต้องเขียนคู่มือหนึ่ง หรืออาจเป็นชุดของคู่มือลำดับชั้นของเอกสารส่วนใหญ่องค์กรคู่มือพอดีภายในลำดับชั้นเอกสารกฎหมายและคู่มือนโยบายทั่วทั้งองค์กร และขั้นตอนและคู่มือทางเทคนิคที่ด้านล่าง คู่มือด้านบนของลำดับชั้นการตั้งค่าพารามิเตอร์ที่ต้องทำตามคู่มือระดับ ประโยชน์ในการร่างลำดับชั้นสำหรับคู่มือขององค์กรเพื่อให้ทุกคนเข้าใจบทบาทของคู่มือใหม่และวิธีมันจะพอดีกับได้ รูปที่ 1-1 แสดงลำดับชั้นเอกสารตัวอย่าง ตรวจสอบให้แน่ใจว่า ที่ทุกคนตกลงกับชนิดที่คุณกำลังเขียนรูปที่ 1-1: ตัวอย่างเอกสารในลำดับชั้นรูปที่ 1-1: ตัวอย่างเอกสารในลำดับชั้นนโยบายคู่มือเอกสารกฎควบคุมองค์กร สามารถกำหนดนโยบายออกที่คณะ องค์กร แผนก กลุ่มงาน หรือระดับอื่น ๆ พวกเขาจะสั้น และทั่ว ไป หรือยาว และรายละเอียด องค์กรส่วนใหญ่ได้ หรือจะได้รับประโยชน์จาก มีคู่มือนโยบายทั่วทั้งองค์กร มันเป็นคู่มือสูงสุดในลำดับชั้นของเอกสาร ปกติตั้งแต่คู่มืออื่น ๆ เช่นคู่มือขั้นตอนภาค โดยทั่วไปจะต้องสอดคล้องกับนโยบายดังกล่าว ในองค์กรขนาดเล็ก นโยบายและขั้นตอนมักจะพบในคู่มือเดียวกัน คู่มือนโยบายมักจะจัด โดยแผนกหรือการทำธุรกิจขั้นตอนคู่มือเอกสารที่ว่าสิ่งที่ทำ การประมวลผลเช่นใบแจ้งหนี้ และมักจะให้บริการในการนำนโยบายไป มักใช้ไดอะแกรมลำดับและขั้นตอน ผู้อ่านมักจะสันนิษฐานเพื่อให้คุ้นเคยกับหัวข้อ แต่มีไม่ทำขั้นตอนมักจะเพียงพอที่จะมีภาพ คู่มือขั้นตอนมักจะจัด ตามงานใน หน้าที่ มีขั้นตอนการจัดกลุ่มตามการทำธุรกิจ หรือ ตามแผนกคู่มือมาตรฐานกำหนดมาตรฐานสำหรับผลิตภัณฑ์ บริการ หรืออื่น ๆ ทำงานกิจกรรม พวกเขาได้ในวิศวกรรม ผลิต และก่อสร้างที่จะใช้ในการระบุผลิตมาตรฐานหรือวัสดุ แต่มาตรฐานจะพบในคู่มือขั้นตอนการตั้งค่าวิธีบ่อย รวดเร็ว หรือความแม่นยำจะทำสิ่ง ตัวอย่าง พวกเขาอาจระบุว่า "ใบแจ้งหนี้ทั้งหมดจะมีชำระภายใน 30 วัน" คู่มือมาตรฐานสามารถจัดในรูปแบบต่าง ๆ เช่นชนิดวัสดุ ระบบ หรืองานหนังสือนำเที่ยว – ให้อ่านละติจูดเพิ่มเติมกว่าคู่มือนโยบายและขั้นตอน ประกอบด้วยแนวทางในการจัดการกับสถานการณ์ต่าง ๆ แนวทางแนะนำมักจะไม่บังคับแทนกฎที่เข้มงวด หรือขั้นตอนอย่างชัดเจน บางครั้งพวกเขาเพียงแค่สร้างขอบเขตซึ่งพนักงานอาจทำหน้าที่ในการพิจารณาตนเอง หนังสือนำเที่ยวมักจะจัดตามงานในหน้าที่ ทำธุรกิจ หรือแผนกคู่มือผู้ใช้ประกอบด้วยคำแนะนำสำหรับการติดตั้ง และใช้ซอฟต์แวร์หรือฮาร์ดแวร์ และควรจัดระเบียบสถานผู้ใช้งาน พวกเขาไม่อธิบายซอฟต์แวร์ในลักษณะรายละเอียดที่คู่มืออ้างอิงอาจ — พวกเขาอธิบายว่า ซอฟต์แวร์ใช้ มักจะ มีขั้นตอนมากมาย คู่มือการใช้เป็นคู่มือหลัก สำหรับผู้ใช้ทั้งหมด แต่โดยเฉพาะอย่างยิ่ง สำหรับสามเณรอ้างอิงคู่มือ – มักจะให้ข้อมูลรายละเอียดเกี่ยวกับฮาร์ดแวร์หรือซอฟต์แวร์ที่จัดสำหรับการอ้างอิงด่วน พวกเขาอาจรวมข้อมูล เช่นรหัสรายการหรือรายชื่อและข้อมูลการติดต่อชนิดอื่น ๆ ด้วย ซอฟต์แวร์ พวกเขามักจะเป็นระบบอธิบายแต่ละฟิลด์ ในแต่ละกล่องโต้ ในแต่ละเมนู ซึ่งแตกต่างจากคู่มือผู้ใช้ ไม่ได้จัดสถานที่งานผู้ใช้ แต่อาจจะ alphabetized โดยคำ หรือเรียงลำดับตามการจัดเรียงพื้นที่ของอินเทอร์เฟซของซอฟแวร์ ผู้อ่านจะถือว่ามีความคุ้นเคยกับซอฟต์แวร์ แต่ต้องการข้อมูลด่วนในบางระบบ นี่ไม่ใช่ประเภทของคู่มือเพื่อให้สามเณรคู่มือฝึกอบรม – ออกแบบสอนอ่านเรื่องใหม่ พวกเขาอาจจะฝึกหัด (อ่านทำบทเรียนในอัตราของตนเอง) หรืออาจถูกออกแบบสำหรับใช้กับหลักสูตรการฝึกอบรมได้ พวกเขาค่อยพยายามสอนทุกอย่าง แต่เพียงแค่พยายามให้รากฐานเบื้องต้นซึ่งผู้อ่านสามารถสร้าง คู่มือการฝึกอบรมจะเริ่ม ด้วยทักษะพื้นฐานและทักษะขั้นสูงที่ผู้อ่านได้รับประสบการณ์และความเชื่อมั่นระหว่างดำเนิน เมื่อซอฟต์แวร์หรือกระบวนงานเป็นการเรียนรู้ คู่มือผู้ใช้หรือคู่มืออ้างอิงโดยทั่วไปใช้คู่มือดำเนินการให้คำแนะนำรายละเอียดการปฏิบัติการของเครื่องมือหรืออุปกรณ์ และอาจรวมถึงการติดตั้งและคำแนะนำในการแก้ไขปัญหา ถ้าเป็นอุปกรณ์ที่ซับซ้อน คู่มือการติดตั้งและบำรุงรักษาแยกต่างหากอาจจะผลิต ผู้อ่านมักจะเป็นวิศวกรหรือช่างเทคนิค เช่นเดียวกับซอฟต์แวร์คู่มือผู้ใช้ คู่มือดำเนินการมักจะจัดรอบงานบริการคู่มือ – ใช้บริการช่างเทคนิคหรือวิศวกรการบำรุง หรือเพื่อแก้ไขปัญหา และแก้ไขปัญหาหรือแบ่ง คู่มือบริการมักจะอธิบายทฤษฎีของวิธีการทำงานของอุปกรณ์ และปฏิบัติงานหลัก และคำแนะนำเกี่ยวกับวิธีการแยกชิ้นส่วน และส่วนประกอบเบ็ด พวกเขามักจะถูกจัดการ โดย ระบบ เช่น "ระบบไฟฟ้า หรือคอมโพเนนต์ฟิลด์แนะนำ – ถูกออกแบบมาสำหรับการใช้งานจากโต๊ะ มักจะกลางแจ้ง พวกเขามักจะใช้ช่วยในการระบุพืชหรือสัตว์ หรืออธิบายเขตข้อมูลทดสอบ ฟิลด์มักมีขนาดเล็กพอที่จะใส่ลงในกระเป๋า และบางครั้งมีพิมพ์บนกระดาษกันน้ำ พวกเขามักจะจัดตามตัวอักษร โดยคำสำคัญสำหรับการอ้างอิงอย่างรวดเร็ว หรืองานในหน้าที่ (เช่นขั้นตอนการสุ่มตัวอย่าง)ชุดคู่มือมัก น้อยสองประเภทของคู่มือจะรวม:นโยบายและขั้นตอนมาตรฐานและแนวทางการดำเนินงานและบริการผู้ใช้และอ้างอิงไม่มีอะไรผิดปกติกับการรวมข้อมูลในคู่มือเดียวชนิดต่าง ๆ ถ้ามันรองรับผู้ชมวัตถุประสงค์และวัตถุประสงค์ของคู่มือ ตัวอย่าง คู่มือองค์กรจำนวนมากรวมนโยบาย ขั้นตอน มาตรฐาน และแนวทาง ถ้ามันเป็นสิ่งสำคัญที่ผู้อ่านมีพร้อมเข้าถึงข้อมูลชนิดต่าง ๆ เหล่านี้ แล้วพิจารณารวมพวกเขา บางครั้งจะเรียกว่าคู่มือเหล่านี้เมื่อพนักงานหรือเพียงนโยบายและขั้นตอนคู่มือ สะท้อนให้เห็นถึงส่วนผสมของชนิดข้อมูลพิจารณาอีกคือ ว่า เมื่อพวกเขาใช้คู่มือ คนส่วนใหญ่แค่ต้องการข้อมูลที่จำเป็นในการทำงาน โดยทั่วไปจะไม่สนใจข้อมูลคือ (เช่นนโยบาย ขั้นตอน มาตรฐาน หรือผลงาน), ไม่สามารถจะได้แยกแยะแบบก็ยังยากสำหรับผู้เขียนเองเพื่อแยกระหว่างชนิดของข้อมูล ตัวอย่าง ถ้าประธานกรรมการทางการเงินต้องตรวจสอบ และออกจากระบบสัญญาทางกฎหมาย เป็นนโยบาย หรือเป็นส่วนหนึ่งของกระบวนการ ปัญหาที่คล้ายกันจะเกิดภัยพิบัติผู้เขียนที่พยายามแยกข้อมูลตามชนิดในบางกรณี อย่างไรก็ตาม เป็นที่เหมาะสมเพื่อแยกชนิดของข้อมูล ตัวอย่าง คุณอาจใส่ด้วยตนเองที่ประกอบด้วยเฉพาะนโยบายคณะกรรมการ หรือผู้บริหารระดับสูงเนื่องจากเป็นระดับของข้อมูลที่พวกเขาจะสนใจใน คู่มือนโยบายและขั้นตอนการบริการให้ ลิขสิทธิ์ © 2006 ดันแคนเคนท์และ จำกัดสมาคมด้านบน

ผลลัพธ์ (ไทย) 2:

1 เกี่ยวกับผู้อ่านและคู่มือการใช้ประเภทของคู่มือการใช้งานก่อนที่จะเริ่มเขียนคุณจะต้องตัดสินใจเกี่ยวกับชนิดของคู่มือ แต่ละชนิดมีวัตถุประสงค์ที่แตกต่างกันและวัตถุประสงค์ที่แตกต่างกัน ในการตัดสินใจที่จะเขียนคุณจะต้องมองในระดับโลกที่องค์กรหรือโปรแกรมของคุณเพื่อดูว่าเอกสารอยู่แล้วว่าคู่มือของคุณจะพอดีและวัตถุประสงค์อะไรมันจะทำหน้าที่. ผู้อ่านของคุณจะใช้เอกสารที่จะเรียนรู้วิธีการใช้งาน ชิ้นใหม่ของอุปกรณ์? ถ้าเป็นเช่นนั้นบางทีคุณควรจะเขียนกวดวิชา หรือถ้าพวกเขารู้อยู่แล้วว่าวิธีการที่จะดำเนินการได้ แต่เพียงสิ่งที่จะต้องกลับไปดูบางครั้งบางทีคุณควรจะเขียนคู่มืออ้างอิง คุณอาจจะต้องเขียนคู่มือการอย่างใดอย่างหนึ่งหรือบางทีอาจจะเป็นชุดของคู่มือ. เอกสารลำดับคู่มือองค์กรส่วนใหญ่พอดีภายในลำดับชั้นเอกสารคู่มือนโยบายกฎหมายและองค์กรทั้งด้านบนและวิธีการและคู่มือเทคนิคที่ด้านล่าง คู่มือการใช้งานที่ด้านบนของพารามิเตอร์การตั้งค่าลำดับชั้นที่คู่มือในระดับต่ำกว่าจะต้องปฏิบัติตาม มันมีประโยชน์ในการร่างคู่มือสำหรับลำดับชั้นขององค์กรของคุณเพื่อให้ทุกคนเข้าใจบทบาทของคู่มือใหม่และวิธีการที่จะเหมาะสมใน. รูปที่ 1-1 แสดงให้เห็นถึงลำดับชั้นของเอกสารตัวอย่าง ตรวจสอบให้แน่ใจว่าทุกคนเห็นด้วยที่พิมพ์ที่คุณกำลังเขียน. รูปที่ 1-1: เอกสารตัวอย่างลำดับชั้นรูปที่1-1: ลำดับชั้นตัวอย่างเอกสารคู่มือนโยบาย- เอกสารกฎเกณฑ์องค์กร นโยบายที่สามารถตั้งค่าออกที่คณะกรรมการองค์กรแผนกกลุ่มงานหรือระดับอื่น ๆ พวกเขาสามารถจะสั้นและทั่วไปหรือยาวและมีรายละเอียด องค์กรส่วนใหญ่มีหรือจะได้รับประโยชน์จากคู่มือนโยบายทั่วทั้งองค์กร ก็มักจะใช้อย่างสูงสุดในลำดับชั้นเอกสารตั้งแต่คู่มืออื่น ๆ เช่นคู่มือขั้นตอนสรรพสินค้ามักจะต้องสอดคล้องกับนโยบายเหล่านั้น ในองค์กรขนาดเล็กนโยบายและขั้นตอนมักจะพบในคู่มือการเดียวกัน คู่มือนโยบายมักจะมีการจัดโดยฟังก์ชั่นทางธุรกิจหรือแผนก. คู่มือขั้นตอน - เอกสารว่าสิ่งที่ทำเช่นการประมวลผลใบแจ้งหนี้และมักจะทำหน้าที่ในการดำเนินการตามนโยบาย ขั้นตอนขั้นตอนโดยขั้นตอนและแผนภาพกระแสที่ใช้บ่อย ผู้อ่านจะสันนิษฐานว่ามักจะคุ้นเคยกับหัวข้อ แต่ยังไม่ได้ดำเนินการตามขั้นตอนมักจะมากพอที่จะได้จดจำมัน คู่มือขั้นตอนที่มีการจัดงานโดยปกติการทำงานด้วยวิธีการจัดกลุ่มตามฟังก์ชั่นธุรกิจหรือโดยกรม. คู่มือมาตรฐาน - มาตรฐานที่กำหนดไว้สำหรับสินค้าบริการหรือกิจกรรมงานอื่น ๆ พวกเขาเป็นเรื่องธรรมดาในวิศวกรรมการผลิตและการก่อสร้างที่พวกเขาจะใช้ในการระบุวัสดุหรือมาตรฐานการผลิต แต่มาตรฐานนอกจากนี้ยังพบในคู่มือขั้นตอนที่จะกำหนดความถี่วิธีที่รวดเร็วหรือว่าสิ่งที่ถูกต้องที่จะทำ ตัวอย่างเช่นพวกเขาอาจจะระบุว่า "ใบแจ้งหนี้ทั้งหมดจะได้รับเงินภายใน 30 วัน." คู่มือมาตรฐานสามารถจัดในรูปแบบต่างๆเช่นตามประเภทของวัสดุระบบหรืองานงาน. คู่มือนำเที่ยว - ให้ผู้อ่านละติจูดมากกว่านโยบายและคู่มือขั้นตอน . พวกเขามีแนวทางในการจัดการกับสถานการณ์ที่แตกต่างกัน แนวทางที่มักจะมีข้อเสนอแนะที่ไม่ได้รับคำสั่งมากกว่ากฎระเบียบที่เข้มงวดหรือขั้นตอนการกำหนดไว้อย่างชัดเจน บางครั้งพวกเขาก็สร้างขอบเขตภายในที่พนักงานอาจทำหน้าที่ขึ้นอยู่กับดุลยพินิจของตัวเอง คู่มือที่มีการจัดงานโดยปกติการทำงานของฟังก์ชั่นทางธุรกิจหรือแผนก. คู่มือผู้ใช้ - มีคำแนะนำสำหรับการติดตั้งและการใช้ซอฟต์แวร์หรือฮาร์ดแวร์และควรจะจัดรอบผู้ใช้งาน พวกเขาไม่ได้อธิบายซอฟต์แวร์ในทางที่มีรายละเอียดที่คู่มืออ้างอิงอาจพวกเขาอธิบายวิธีการที่ซอฟต์แวร์ที่ใช้มักจะมีจำนวนมากของขั้นตอนขั้นตอนโดยขั้นตอน คู่มือผู้ใช้เป็นหลักคู่มือสำหรับผู้ใช้ทั้งหมด แต่โดยเฉพาะอย่างยิ่งสำหรับสามเณร. คู่มืออ้างอิง - มักจะให้รายละเอียดเกี่ยวกับฮาร์ดแวร์หรือซอฟต์แวร์จัดสำหรับการอ้างอิงอย่างรวดเร็ว พวกเขายังอาจรวมถึงข้อมูลประเภทอื่น ๆ เช่นรายชื่อรหัสหรือรายการของชื่อและข้อมูลการติดต่อ ซอฟแวร์สำหรับพวกเขามักจะเป็นระบบอธิบายแต่ละเขตข้อมูลในแต่ละกล่องโต้ตอบในแต่ละเมนู ซึ่งแตกต่างจากคู่มือพวกเขาจะไม่จัดรอบผู้ใช้งาน แต่อาจจะตามตัวอักษรด้วยคำหลักหรือติดใจไปตามการจัดพื้นที่ของอินเตอร์เฟซซอฟแวร์ ผู้อ่านจะถือว่ามีความคุ้นเคยกับซอฟแวร์ แต่ต้องการข้อมูลอย่างรวดเร็วในลักษณะของระบบบางส่วน นี้ไม่ได้เป็นชนิดของคู่มือที่จะให้แก่สามเณร. คู่มือการฝึกอบรม - ได้รับการออกแบบมาเพื่อสอนให้ผู้อ่านสิ่งใหม่ ๆ พวกเขาอาจจะรู้ด้วยตนเอง (ผู้อ่านทำแบบฝึกหัดในอัตราของตัวเอง) หรือพวกเขาอาจจะได้รับการออกแบบมาเพื่อใช้กับการฝึกอบรมหลักสูตร พวกเขาแทบจะไม่พยายามที่จะสอนทุกอย่าง แต่ก็พยายามที่จะให้พื้นฐานตามที่ผู้อ่านสามารถสร้าง คู่มือการฝึกอบรมมักจะเริ่มต้นด้วยทักษะพื้นฐานและความคืบหน้าทักษะที่สูงขึ้นในขณะที่ผู้อ่านได้รับประสบการณ์และความเชื่อมั่น เมื่อซอฟต์แวร์หรือขั้นตอนจะเรียนรู้คู่มือผู้ใช้หรืออ้างอิงคู่มือมักจะถูกนำมาใช้. คู่มือประกอบการ - ให้คำแนะนำรายละเอียดของเครื่องมือหรืออุปกรณ์ในการดำเนินงานและอาจรวมถึงการติดตั้งและคำแนะนำการแก้ไขปัญหา ถ้ามันเป็นอุปกรณ์ที่ซับซ้อนติดตั้งแยกต่างหากและคู่มือการบำรุงรักษาอาจจะผลิต ผู้อ่านมักจะเป็นวิศวกรหรือช่างเทคนิค คล้ายกับคู่มือผู้ใช้ซอฟต์แวร์, คู่มือผู้ประกอบการที่มีการจัดงานปกติประมาณทำงาน. คู่มือการให้บริการ - มีการใช้โดยช่างบริการหรือวิศวกรที่จะดำเนินการซ่อมบำรุงประจำหรือการแก้ไขปัญหาและแก้ไขปัญหาหรือความเสียหาย คู่มือบริการมักจะอธิบายทฤษฎีของวิธีการทำงานของอุปกรณ์และหลักการการดำเนินงานและคำแนะนำเกี่ยวกับวิธีการถอดและประกอบชิ้นส่วน พวกเขามักจะมีการจัดระบบเช่น "ระบบไฟฟ้า" หรือองค์ประกอบ. คู่มือภาคสนาม - ได้รับการออกแบบสำหรับการใช้งานออกไปจากโต๊ะทำงานนอกบ้านมักจะ พวกเขาจะใช้กันทั่วไปเพื่อช่วยในการระบุพืชหรือสัตว์หรือที่จะอธิบายการทดสอบสนาม คู่มือภาคสนามมักจะมีขนาดเล็กพอที่จะใส่ลงในกระเป๋าและบางครั้งจะถูกพิมพ์ลงบนกระดาษกันน้ำ พวกเขามักจะจัดลำดับตามตัวอักษรคำหลักสำหรับการอ้างอิงอย่างรวดเร็วหรืองานการทำงาน (เช่นขั้นตอนการสุ่มตัวอย่าง). คู่มือการใช้งานรวมกันบ่อยครั้งที่สองหรือมากกว่าประเภทคู่มือจะรวมกัน: นโยบายและขั้นตอนมาตรฐานและแนวทางการดำเนินงานและการให้บริการของผู้ใช้และการอ้างอิงไม่มีอะไรที่เป็นผิดกับการรวมชนิดที่แตกต่างของข้อมูลในคู่มือเดียวถ้ามันมีจุดมุ่งหมายและผู้ชมที่ตั้งใจไว้ของคู่มือ ยกตัวอย่างเช่นคู่มือหลายองค์กรรวมนโยบายขั้นตอนมาตรฐานและแนวทางการปฏิบัติ ถ้ามันเป็นสิ่งสำคัญที่ผู้อ่านที่ตั้งใจไว้มีการเข้าถึงเหล่านี้พร้อมที่จะแตกต่างกันของข้อมูลแล้วพิจารณารวมพวกเขา คู่มือเหล่านี้บางครั้งเรียกว่าคู่มือพนักงานหรือเพียงแค่นโยบายและคู่มือขั้นตอนการสะท้อนให้เห็นถึงการผสมผสานของประเภทข้อมูล. พิจารณาก็คือว่าเมื่อพวกเขากำลังใช้คู่มือคนส่วนใหญ่เป็นเพียงการมองหาข้อมูลที่จำเป็นในการรับงานของพวกเขาทำ โดยปกติแล้วพวกเขาไม่สนใจสิ่งที่ประเภทของข้อมูลที่เป็น (เช่นนโยบายขั้นตอนมาตรฐานหรือแนวทาง) ไม่สามารถที่พวกเขาสามารถแยกได้ระหว่างประเภท. นอกจากนี้ยังเป็นเรื่องยากสำหรับนักเขียนคู่มือที่จะแยกแยะความแตกต่างระหว่างประเภทข้อมูล ตัวอย่างเช่นถ้าประธานและผู้อำนวยการของกระทรวงการคลังจะต้องตรวจสอบและลงนามในสัญญาทางกฎหมายที่เป็นนโยบายหรือเป็นส่วนหนึ่งของขั้นตอนหรือไม่ ปัญหาที่คล้ายกันจะทำให้เกิดภัยพิบัตินักเขียนที่พยายามจะแยกข้อมูลโดยแบ่งตามชนิด. ในบางสถานการณ์ แต่ก็มีความเหมาะสมที่จะแยกประเภทของข้อมูล ตัวอย่างเช่นคุณอาจจัดให้มีคู่มือที่มีนโยบายเฉพาะกับคณะกรรมการ บริษัท หรือผู้บริหารระดับสูงตั้งแต่นี้เป็นระดับของข้อมูลที่พวกเขาจะมีความสนใจในขณะที่ให้ผู้ใช้ที่มีนโยบายและขั้นตอนการปฏิบัติให้กับเจ้าหน้าที่ก. ลิขสิทธิ์© 2006 ดันแคนเคนท์ & Associates Ltd. ยอดนิยม

ผลลัพธ์ (ไทย) 3:

1 เรื่อง ผู้อ่าน และประเภทของคู่มือคู่มือ



ก่อนที่จะเริ่มเขียน คุณจะต้องตัดสินใจเกี่ยวกับชนิดของคู่มือ แต่ละชนิดมีวัตถุประสงค์ที่แตกต่างกันและวัตถุประสงค์ที่แตกต่างกัน ตัดสินใจที่จะเขียน คุณจะต้องดูที่องค์กรทั่วโลกหรือโปรแกรมของคุณเพื่อดูเอกสารอะไรอยู่แล้ว ว่าคู่มือของคุณจะพอดีในและสิ่งที่ประสงค์จะให้บริการ .

ผู้อ่านของคุณจะใช้เอกสารเพื่อเรียนรู้วิธีการใช้งานชิ้นใหม่ของอุปกรณ์ ถ้าบางทีคุณควรเขียนกวดวิชา หรือถ้าพวกเขารู้วิธีที่จะใช้มัน แต่เพียงต้องการบางสิ่งบางอย่างเพื่อกลับไปดูเป็นครั้งคราว บางทีคุณควรเขียนอ้างอิงคู่มือ คุณอาจต้องการที่จะเขียนคู่มือ หรือบางทีชุดของคู่มือเอกสารลำดับชั้น

.

คู่มือองค์การส่วนใหญ่พอดีภายในลำดับชั้นของเอกสารกับกฎหมายและนโยบายองค์กรกว้างคู่มือที่ด้านบน และขั้นตอนและคู่มือทางเทคนิคที่ด้านล่าง คู่มือที่ด้านบนของลำดับชั้นการตั้งค่าพารามิเตอร์ที่คู่มือการใช้งานระดับล่างต้องปฏิบัติตามมันมีประโยชน์ต่อร่างคู่มือลำดับชั้นสำหรับองค์กรของคุณเพื่อให้ทุกคนเข้าใจบทบาทของตนเองใหม่ และวิธีการก็จะพอดีกับ รูปที่ 1-1 แสดงตัวอย่างเอกสารลำดับชั้น . ตรวจสอบให้แน่ใจว่า ทุกคนยอมรับในประเภทที่คุณเขียน

รูปที่ 1-1 : ตัวอย่างเอกสารลำดับชั้น
รูป 1-1 : ตัวอย่างเอกสารลำดับชั้น

คู่มือนโยบาย–เอกสารกฎระเบียบในองค์กร สามารถกำหนดนโยบายที่คณะกรรมการ องค์การ หน่วยงาน กลุ่มงาน หรืออื่น ๆ ระดับ พวกเขาสามารถจะสั้นและทั่วไป หรือยาว และรายละเอียด องค์กรส่วนใหญ่มีหรือจะได้รับประโยชน์จากองค์กรกว้างคู่มือนโยบาย มันมักจะใช้สูงสุดในเอกสารลำดับชั้น ตั้งแต่คู่มืออื่น ๆเช่นคู่มือแผนก โดยปกติจะต้องปฏิบัติตามนโยบายดังกล่าว ในองค์กรขนาดเล็ก , นโยบายและวิธีการที่มักจะพบได้ในคู่มือการใช้งานเดียวกัน คู่มือนโยบายมักจะจัดโดยฟังก์ชันทางธุรกิจหรือแผนก และเอกสารคู่มือ

ขั้นตอนว่าสิ่งที่ทำเช่นการประมวลผลใบแจ้งหนี้และมักจะให้ใช้นโยบายขั้นตอนโดยขั้นตอนขั้นตอนและแผนภาพการไหลจะใช้เป็นประจำ ผู้อ่านมักจะถือว่ามีความคุ้นเคยกับหัวข้อ แต่ยังไม่ได้ทำการผ่าตัดมักจะเพียงพอที่จะได้จำมัน คู่มือขั้นตอนที่มักจะจัดโดยงานที่ทำ ด้วยวิธีการจัดกลุ่มตามฟังก์ชันทางธุรกิจหรือโดยแผนก

มาตรฐานคู่มือ–ชุดมาตรฐานสำหรับผลิตภัณฑ์ บริการหรืองานอื่น ๆ กิจกรรม พวกเขามีทั่วไปในวิศวกรรม การผลิต และการก่อสร้างที่พวกเขาจะใช้เพื่อระบุวัสดุหรือมาตรฐานการผลิต แต่มาตรฐานที่พบในคู่มือการตั้งค่าออกบ่อยได้อย่างรวดเร็วหรือวิธีการที่ถูกต้อง สิ่งที่จะทำ ตัวอย่างเช่นพวกเขาอาจระบุว่า " ใบแจ้งหนี้ทั้งหมดจะได้รับเงินภายใน 30 วัน" คู่มือมาตรฐานสามารถจัดในรูปแบบต่างๆ เช่น ระบบประเภท วัสดุ หรืองานงาน

คู่มือ–ให้ผู้อ่านเพิ่มเติมละติจูดกว่านโยบายและขั้นตอนคู่มือ มีแนวทางในการรับมือกับสถานการณ์ที่แตกต่างกัน แนวทางมักจะไม่บังคับข้อเสนอแนะมากกว่ากฎระเบียบที่เข้มงวดและชัดเจนขั้นตอนบางครั้งพวกเขาก็สร้างขอบเขตภายในที่พนักงานอาจจะขึ้นอยู่กับดุลยพินิจของตนเอง คู่มือท่องเที่ยวมักจะจัดโดย งาน งาน ธุรกิจ การทำงาน หรือแผนก

คู่มือผู้ใช้และมีคำแนะนำสำหรับการติดตั้งและใช้ซอฟต์แวร์หรือฮาร์ดแวร์ และควรจัดรอบของผู้ใช้งานพวกเขาไม่อธิบายซอฟต์แวร์ในลักษณะรายละเอียดที่อ้างอิงคู่มือพวกเขาอาจอธิบายวิธีการที่ซอฟต์แวร์ที่ใช้มักจะมีกระบวนการขั้นตอนที่ คู่มือผู้ใช้คู่มือเบื้องต้นสำหรับผู้ใช้ทั้งหมด แต่โดยเฉพาะอย่างยิ่งสำหรับสามเณร .

อ้างอิงคู่มือ–มักจะให้ข้อมูลรายละเอียดเกี่ยวกับฮาร์ดแวร์หรือซอฟต์แวร์ที่จัดสำหรับการอ้างอิงอย่างรวดเร็วพวกเขายังอาจรวมถึงประเภทอื่น ๆของข้อมูล เช่น รหัสรายการหรือรายการของชื่อและข้อมูลติดต่อ ซอฟต์แวร์ พวกเขามักจะสามารถอธิบายแต่ละเขต ในแต่ละกล่องโต้ตอบ ในแต่ละเมนู ซึ่งแตกต่างจากคู่มือผู้ใช้ , พวกเขาจะไม่จัดรอบๆงาน ผู้ใช้ แต่อาจเป็นอักษรโดยคำหลักหรือการจัดเรียงลำดับตามพื้นที่ของซอฟต์แวร์อินเตอร์เฟซผู้อ่านจะถือว่าคุ้นเคยกับซอฟต์แวร์ แต่ต้องการข้อมูลที่รวดเร็วในบางแง่มุมของระบบ นี้ไม่ได้เป็นชนิดของคู่มือให้มือใหม่

คู่มือการฝึกอบรมและถูกออกแบบมาเพื่อสอนให้ผู้อ่านสิ่งใหม่ พวกเขาอาจจะด้วยตนเอง paced ( อ่านทำแบบฝึกหัดในอัตราของตัวเอง ) หรือพวกเขาอาจจะได้รับการออกแบบสำหรับใช้กับหลักสูตรฝึกอบรม พวกเขาแทบจะไม่พยายามสอนทุกอย่างแต่ก็พยายามจะให้รากฐานที่ผู้อ่านสามารถสร้าง คู่มือการฝึกอบรมมักจะเริ่มต้นด้วยทักษะพื้นฐานและก้าวหน้าทักษะขั้นสูงเพิ่มเติมเป็นผู้อ่านได้รับประสบการณ์และความเชื่อมั่น เมื่อซอฟต์แวร์หรือวิธีการเรียนรู้ คู่มือหรือคู่มืออ้างอิงที่ใช้โดยทั่วไป .

คู่มือการดําเนินการและให้คำแนะนำรายละเอียดเพื่อใช้เครื่องมือหรืออุปกรณ์ และอาจรวมถึงการติดตั้งและคำแนะนำการแก้ไขปัญหา ถ้าเป็นอุปกรณ์ที่ซับซ้อนแยก ติดตั้งและซ่อมแซมคู่มืออาจจะผลิต อ่านบ่อยๆ เป็นวิศวกร หรือช่างเทคนิค คล้ายกับซอฟต์แวร์คู่มือผู้ใช้คู่มือผู้ประกอบการมักจะจัดรอบ

งานงานบริการคู่มือ–ใช้โดยวิศวกร ช่างเทคนิค หรือการซ่อมบำรุงตามปกติ หรือเพื่อแก้ไขปัญหาและการแก้ไขปัญหา หรือ เสีย บริการคู่มือมักจะอธิบายทฤษฎีของวิธีการและอุปกรณ์งานปฏิบัติการหลักการและวิธีถอดและรวมกันอีกครั้งส่วนประกอบ พวกเขามักจะมีการจัดโดยระบบ เช่น ระบบไฟฟ้า ระบบ " หรือส่วนประกอบ

ฟิลด์คู่มือ–ถูกออกแบบมาสำหรับใช้ห่างจากโต๊ะ มักจะอยู่กลางแจ้ง พวกเขามักจะใช้เพื่อช่วยระบุพืช หรือสัตว์ หรืออธิบายการทดสอบภาคสนาม ข้อมูลแนะนำมักจะมีขนาดเล็กพอที่จะใส่ในกระเป๋า และมีบางครั้งที่พิมพ์บนกระดาษกันน้ำ พวกเขามักจะมีการจัดเรียงตามตัวอักษรโดยคำหลักสำหรับการอ้างอิงอย่างรวดเร็ว หรืองานที่ทำ ( เช่น ตัวอย่าง

ขั้นตอน )ชุดคู่มือ

มักจะสองหรือมากกว่าประเภทของคู่มือรวม :


มาตรฐานและแนวทางนโยบายและขั้นตอนการดำเนินงานและบริการ

ใช้และการอ้างอิง
ไม่มีอะไรผิดปกติกับการรวมชนิดที่แตกต่างกันของข้อมูลในคู่มือเดียวถ้ามันทำหน้าที่ และผู้ชมเป้าหมายของคู่มือ ตัวอย่างเช่นคู่มือองค์การหลายรวมนโยบาย ขั้นตอน มาตรฐานและแนวทาง ถ้ามันสำคัญมากที่จะตั้งใจอ่านพร้อมที่จะเข้าถึงเหล่านี้แตกต่างกันประเภทของข้อมูลแล้วพิจารณารวมเกมส์ คู่มือเหล่านี้บางครั้งเรียกว่าพนักงานคู่มือหรือเพียงแค่นโยบายและขั้นตอนคู่มือ , สะท้อนให้เห็นถึงส่วนผสมของประเภทข้อมูล

อีกปัจจัยคือว่าเมื่อพวกเขามีการใช้คู่มือคนส่วนใหญ่จะหาข้อมูลที่จำเป็นในการได้รับงานของพวกเขาทำ โดยทั่วไปแล้วพวกเขาไม่สนใจสิ่งที่ชนิดของข้อมูลก็ไม่ได้ ( เช่น นโยบาย ขั้นตอน มาตรฐานหรือแนวปฏิบัติ ) , และพวกเขาสามารถได้อย่างง่ายดายแยกความแตกต่างระหว่างชนิด

มันยังยากสำหรับนักเขียนคู่มือเพื่อแยกความแตกต่างระหว่างชนิดข้อมูล ตัวอย่างเช่นถ้าท่านประธานและผู้อำนวยการฝ่ายการเงิน ต้องตรวจสอบและลงนามในสัญญาทางกฎหมาย นี่คือนโยบายหรือเป็นส่วนหนึ่งของกระบวนการ ? ปัญหาที่คล้ายกันจะระบาดนักเขียนที่พยายามจะแยกรายละเอียดตามประเภท

ในบางสถานการณ์ แต่มันเป็นที่เหมาะสมเพื่อแยกประเภทของข้อมูล ตัวอย่างเช่นคุณอาจให้ คู่มือที่มีนโยบายให้คณะกรรมการ หรือผู้บริหารระดับสูง ตั้งแต่นี้เป็นระดับของข้อมูลที่พวกเขาจะสนใจในขณะที่ให้คู่มือที่มีทั้งนโยบายและวิธีการให้พนักงาน


ลิขสิทธิ์© 2006 ดันแคน เคนท์& Associates จำกัด ด้านบน