มาตรฐานการเขียนเอกสารปฏิบัติการแบบ Human-first

แผนก

ครีเอทีฟ

สารบัญ


วัตถุประสงค์

เอกสารนี้นิยามวิธีการที่ Kiluth เขียนเอกสารปฏิบัติการเพื่อให้ง่ายต่อการติดตาม ง่ายต่อการบำรุงรักษา และปลอดภัยต่อการดำเนินการ

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

ขอบเขต

มาตรฐานนี้ใช้กับเอกสารปฏิบัติการทางการทั้งหมดของ Kiluth ทุกแผนก (Technology, Marketing, Finance, Legal, Delivery, Creative, HR, Account Management)

รวมถึง
1น้ำเสียงและสไตล์การเขียน
2กฎโครงสร้างและรูปแบบขั้นต่ำ
3วิธีเขียนจุดตรวจสอบ / จุดตัดสินใจและการส่งมอบงาน

โมเดลการดำเนินงาน

โมเดลการดำเนินงาน
1Asana เป็นระบบบันทึก สำหรับการติดตามงาน การอนุมัติ และการส่งมอบงาน
2ใช้จุดตรวจสอบและจุดตัดสินใจ: ไม่ดำเนินการต่อจนกว่าขั้นตอนก่อนหน้าจะ “เสร็จ” และการแยกทางมีความชัดเจน
3ลำดับการส่งมอบงาน: ฝ่ายต้นน้ำกำหนดสิ่งส่งมอบ/เกณฑ์การออก; ฝ่ายปลายน้ำกำหนดการดำเนินการหลังการส่งมอบ

หลักการเขียน (มาตรฐาน Kiluth)

หลักการสิ่งที่หมายถึงในทางปฏิบัติ
Human-firstเขียนสำหรับคนจริงที่ทำงานจริง สมมติว่าพวกเขากำลังยุ่ง ลดการอ่านและภาระทางปัญญา ทำให้แต่ละขั้นตอนง่ายต่อการค้นหาและติดตามโดยแยกกระบวนการที่ซับซ้อนออกเป็นส่วนย่อย ๆ แต่ละส่วน
เรียบง่ายเลือกประโยคสั้นและคำที่ใช้กันทั่วไป ลบคำฟุ่มเฟือย (“in order to”, “it is important to”)
น้อยที่สุดเก็บเฉพาะสิ่งที่ป้องกันข้อผิดพลาดหรือแก้ไขความสับสนทั่วไป หากไม่ได้ใช้ ให้ลบออก
เป็นรูปธรรมใช้ “ทำ X วางลิงก์ Y ที่นี่ ดำเนินการต่อเมื่อ Z เป็นจริง” เลือกตัวอย่าง เทมเพลต และรายการตรวจสอบ รวมคำอธิบายกระบวนการแบบมีหมายเลขภายในแต่ละขั้นตอนเพื่อแสดงสิ่งที่ต้องเกิดขึ้นอย่างชัดเจน
วิทยาศาสตร์ / ข้อมูลก่อนเลือกข้อเท็จจริง สิ่งส่งมอบ ประทับเวลา ลิงก์ และหลักฐานมากกว่าความคิดเห็นและความจำ
มีโครงสร้างใช้หัวข้อที่สอดคล้องกัน ตาราง 2 คอลัมน์สำหรับกระบวนการ/รายการ และเจ้าของที่ชัดเจนสำหรับการส่งมอบงาน แยกแต่ละขั้นตอนหลักออกเป็นส่วนของตัวเองเพื่อการนำทางและความเข้าใจที่ง่ายขึ้น
ยืดหยุ่นกำหนดเส้นทางค่าเริ่มต้น แต่อนุญาตข้อยกเว้นผ่านจุดตัดสินใจที่ชัดเจนและการเบี่ยงเบนที่บันทึกไว้

โครงสร้างเอกสาร (ขั้นต่ำ)

เอกสารทางการทั้งหมดของ Kiluth ควรรวมถึง:

จำเป็น
1หัวข้อ (H1)
2บรรทัด แผนก ใต้หัวข้อ (ข้อความธรรมดา)
3## สารบัญ (มีอยู่เสมอ; ตาราง 2 คอลัมน์)
4ส่วนทีละขั้นตอนสำหรับกระบวนการหลัก (เมื่อเป็นเอกสารกระบวนการ)
5บทบาท/เจ้าของสำหรับการส่งมอบงาน (ใครสร้างงานถัดไป / ใครอนุมัติ / ใครลิงก์หลักฐาน)

แนะนำเมื่อเกี่ยวข้อง:

แนะนำ
1ส่วนวิธีใช้งาน (สำหรับเอกสารกระบวนการ): อธิบายวิธีใช้เอกสารทีละขั้นตอน แต่ละส่วนอธิบายอะไร และเมื่อไหร่ควรปฏิบัติตามส่วนต่าง ๆ ตามลำดับ
2ส่วนภาพรวม (สำหรับเอกสารกระบวนการ): ให้บริบทระดับสูงเกี่ยวกับกระบวนการก่อนลงรายละเอียดขั้นตอน
3โครงสร้างขั้นตอนแบบละเอียด: แยกแต่ละขั้นตอนหลักออกเป็นส่วนของตัวเอง (H2) แทนที่จะจัดกลุ่มขั้นตอนทั้งหมดไว้ภายใต้ส่วน “ขั้นตอนการทำงานแบบทีละขั้น” เดียว ทำให้การติดตามและนำทางกระบวนการง่ายขึ้น
4คำอธิบายกระบวนการ: รวมรายการแบบมีหมายเลขภายในแต่ละขั้นตอนเพื่อแสดงสิ่งที่ต้องเกิดขึ้น (เช่น “กระบวนการประเมินของ PM: 1. ทบทวนขอบเขต 2. พิจารณาความซับซ้อน 3. ประมาณการช่วง…“)
5เทมเพลตการ์ด Asana สำหรับการส่งมอบงาน (หัวข้อ / ผู้รับผิดชอบ / คำอธิบาย)
6รายการตรวจสอบสั้นๆ ในตอนท้าย (เฉพาะหากกระบวนการมีการส่งมอบงาน/ขั้นตอนหลายอย่าง)
7จุดตัดสินใจในตาราง `ผลลัพธ์

กฎภาษาและคำศัพท์

หัวข้อกฎ
คำว่า “Gate”หลีกเลี่ยง “gate” ใช้ จุดตรวจสอบ สำหรับการตรวจสอบขั้นตอนและ จุดตัดสินใจ สำหรับการแยกทาง
การอนุมัติเลือกภาษา “หลักฐานการอนุมัติ” และทำให้ลิงก์ได้จาก Asana เสมอ หากเกี่ยวข้องกับสัญญา ต้องใช้เอกสารที่ลงนามแล้ว
หลีกเลี่ยงน้ำเสียงบังคับนโยบายเลือก “ดำเนินการต่อเมื่อ…” แทน “ต้อง / ไม่สามารถ” เว้นแต่กฎป้องกันความเสี่ยงจริง
การส่งมอบงานระบุเสมอ: เจ้าของ → สิ่งส่งมอบ → ที่ที่จะลิงก์ → “เสร็จ” หมายถึงอะไร

ตัวอย่าง (ก่อน / หลัง)

ก่อน (คลุมเครือเกินไป)หลัง (สไตล์ Kiluth)
“ให้แน่ใจว่าลูกค้าจัดแนวกันก่อนดำเนินการต่อ""ดำเนินการต่อเมื่อหลักฐานการอนุมัติจากลูกค้าถูกลิงก์ใน Asana: Sign-off proof: [Link] (บันทึกการประชุมหรือเอกสารที่ลงนามแล้ว; เอกสารที่ลงนามแล้วจำเป็นสำหรับการตัดสินใจที่เกี่ยวข้องกับสัญญา)"
"Go-live ควรทำอย่างระมัดระวัง""ในงาน go-live เขียน: (1) ลิงก์แผน rollback (2) รายการตรวจสอบการตรวจสอบ (3) หน้าต่างการดำเนินการ (4) ผลลัพธ์: ตรวจสอบแล้ว / Rolled back”

รายการตรวจสอบ (สำหรับผู้เขียน)

รายการตรวจสอบ
1☐ ทุกขั้นตอนสามารถดำเนินการได้ (ใครบางคนสามารถทำได้โดยไม่ต้องเดา)
2☐ ทุกการส่งมอบงานมีเจ้าของ + สิ่งส่งมอบ + ตำแหน่งลิงก์ + เกณฑ์การออก
3☐ จุดตรวจสอบ/จุดตัดสินใจมีความชัดเจน (ไม่มีการแยกทางที่ซ่อนอยู่)
4☐ เทมเพลตมีอยู่สำหรับการส่งมอบงานข้ามแผนก
5☐ เอกสารสั้นกว่าที่ต้องการ (ลบข้อความที่ดีต่อการมี)
6☐ คำศัพท์สอดคล้องกันทุกแผนก (ป้ายกำกับเดียวกันเมื่อเป็นไปได้)