ได้รับการจัด! วิธีสร้างคู่มือสไตล์ฐานความรู้

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

คุณต้องแน่ใจว่า:

• การใช้น้ำเสียงที่เหมาะสม
• จัดรูปแบบทุกอย่างเหมือนเดิม

ซึ่งด้วยเหตุผลที่ฉันจะอธิบายในหัวข้อถัดไป เป็นเรื่องที่ยากอย่างน่าประหลาดใจ นั่นคือที่มาของแนวทางรูปแบบฐานความรู้

เหตุใดฐานความรู้ของคุณจึงดูยุ่งเหยิงในสไตล์ที่แตกต่าง

อย่ากังวลมากเกินไปหากฐานความรู้ของคุณมีสไตล์ที่แตกต่างหลากหลาย มันเกิดขึ้นกับบริษัทมากมาย ซึ่งมักจะเกิดจากหนึ่งในสองเหตุผล (หรือบางครั้งอาจทั้งสองอย่าง!)

อย่างแรก หากคุณเป็นส่วนหนึ่งของทีม คุณอาจมีคนหลายคนที่เขียนเอกสารสนับสนุน ดังนั้นถ้า:

• จิมเขียน บทความ A
• แซลลี่เขียน บทความ B

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

ตอนนี้ ถ้าคุณไม่ได้เป็นส่วนหนึ่งของทีม คุณอาจจะพูดว่า “ฉันเป็นหมาป่าเดียวดาย – ฉันกำลังเขียนทุกอย่างด้วยตัวเอง ดังนั้นฉันไม่จำเป็นต้องเขียนอะไรลงในกระดาษ – มันคือทั้งหมดของฉัน!”

และนั่นอาจเป็นกรณี... ถ้าคุณเขียนบทความฐานความรู้ทั้งหมดของคุณในคราวเดียว

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

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

ดังนั้นไม่ว่าคุณจะเล่นคนเดียวหรือเป็นส่วนหนึ่งของทีม การวางคู่มือสไตล์ฐานความรู้ของคุณลงบนกระดาษก็คุ้มค่า

บริษัททำสิ่งนี้จริงหรือ คู่มือสไตล์ฐานความรู้เป็นของจริงหรือไม่?

ตกลง ฉันจะบอกคุณถึงวิธีสร้างคู่มือสไตล์ของคุณในอีกสักครู่ แต่ก่อนอื่น ฉันต้องการนำตัวอย่างของบริษัทต่างๆ ที่ทำสิ่งนี้จริงๆ สิ่งนี้บรรลุเป้าหมายสองประการ:

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

มาดู Mozilla กันก่อน Mozilla มีรายการทั้งหมดในคู่มือสไตล์สำหรับฐานความรู้ของพวกเขา เนื่องจาก Mozilla เป็นโอเพ่นซอร์ส จึงจำเป็นอย่างยิ่งที่พวกเขาจะต้องมีคู่มือสไตล์ในการ "ทำให้ Firefox รองรับฐานความรู้ที่สอดคล้องกัน ส่งผลให้มีฐานความรู้ที่อ่านง่ายและสนับสนุน" อ่านง่าย? ฟังดูเหมือนเป็นเป้าหมายที่ดีสำหรับฐานความรู้ของคุณใช่ไหม

คู่มือนี้ลงลึกถึงรายละเอียดทุกอย่างตั้งแต่การใช้อักษรตัวพิมพ์ใหญ่ ช่องว่าง ไปจนถึงเครื่องหมายจุลภาค

ถัดมา Voice & Tone ของ MailChimp เป็นอีกเรื่องที่น่าอ่าน แม้ว่าจะไม่เน้นที่ฐานความรู้ 100% แต่ก็มีรายการจำนวนมากสำหรับทั้งฐานความรู้และเนื้อหาบทช่วยสอน:

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

วิธีสร้างคู่มือสไตล์สำหรับฐานความรู้ของคุณ

ฉันยกตัวอย่างสองสามตัวอย่างให้คุณ แต่ฉันยังไม่ได้ให้ขั้นตอนในการสร้างคู่มือสไตล์ฐานความรู้ของคุณเองจริงๆ มาแก้ไขกันเถอะ!

ใช้บุคคลที่สอดคล้อง

คุณเคยอ่านบทความที่ผู้เขียนสลับไปมาระหว่าง "ฉัน" กับ "เรา" หรือไม่? ฉันมีและเราสามารถบอกคุณได้ว่ามันน่าสับสนมาก

ดังนั้น หากคุณกำลังจะใช้คนแรก – เลือกหนึ่งอย่างและสอดคล้องกัน แม้ว่าคุณจะโซโล คุณก็ยังเลือกใช้ “เรา” ได้ แล้วแต่คุณ! แค่ใช้ตัวเดียวกัน

นอกจากนี้ คุณไม่จำเป็นต้องใช้คนแรกด้วยซ้ำ คุณสามารถเลือกที่จะหลีกเลี่ยง "ฉัน" และ "เรา" ได้ทั้งหมด

ไม่มีคำตอบที่ถูกต้องที่นี่ – มันเกี่ยวกับความสม่ำเสมอเท่านั้น

ทำให้การจัดรูปแบบของคุณเป็นมาตรฐาน

หากคุณอ่านคู่มือเทมเพลตบทความฐานความรู้ขั้นสูงสุดของเรา คุณจะรู้ว่าฐานความรู้ที่ดีนั้นใช้คำแนะนำจำนวนมากโดยมีขั้นตอนเล็กๆ น้อยๆ และในบางจุดคำแนะนำเหล่านั้นจะรวมถึงภาษาเช่น:

คลิกที่ ไฟล์

ดังนั้น – คือ:

• คลิกที่ ไฟล์
• คลิกที่ "ไฟล์"
• คลิกที่ ไฟล์

และเมื่อคุณเขียนรายการของคุณจริงๆ มันคือ:

• ขั้นตอนที่ 1: คลิกที่นี่
• ขั้นตอนที่ 2: คลิกที่นั้น

หรือเป็นเช่นนี้:

• คลิกที่นี่
• คลิกที่นั้น

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

มีตัวเลือกการจัดรูปแบบอื่นๆ ที่คุณต้องทำเช่นกัน - คู่มือสไตล์ Mozilla ช่วยให้คุณมีความคิดที่ดีในทุกสิ่งที่จะครอบคลุม แต่นี่คือแนวคิดเริ่มต้นบางส่วน:

• หัวเรื่องอักษร ตัวพิมพ์ใหญ่ - คุณจะใช้ตัวพิมพ์ประโยคหรือตัวพิมพ์ชื่อเรื่องหรือไม่?
• ตัวเลข - มันคือ 10 หรือสิบ?
• ตัวย่อ - ไม่หรือไม่?
• ตัวย่อ – CDN หรือเครือข่ายการจัดส่งเนื้อหา?

หากคุณกำลังใช้หนึ่งในธีมหรือปลั๊กอิน WordPress ฐานความรู้ของเรา รหัสย่อและตัวเลือกการจัดรูปแบบในตัวของเราสามารถช่วยให้คุณมีความสอดคล้องกันเมื่อต้องมีการจัดรูปแบบ

รับเสียงที่ถูกต้อง

สุดท้ายนี้ คุณต้องไปไกลกว่าการจัดรูปแบบและสร้างมาตรฐานให้กับเสียงของคุณ

คุณเป็นเพื่อนของลูกค้าหรือไม่? หรือคุณคือสป็อคจาก Star Trek ที่แจกจ่ายภูมิปัญญาอันเยือกเย็นอย่างไม่แยแส?

ภายในเหตุผลอย่างใดอย่างหนึ่งก็ดี ตราบใดที่ยังสม่ำเสมอ

โดยทั่วไป คุณควรปฏิบัติตามคำแนะนำในฐานความรู้ของ MailChimp ฉันแนะนำพวกเขาไม่เพียงเพราะ MailChimp เผยแพร่คู่มือของพวกเขาเท่านั้น แต่ยังเพราะฉันคิดว่า MailChimp มีฐานความรู้ที่ดีที่สุดแห่งหนึ่ง

คำแนะนำของพวกเขาคือ:

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

จะเก็บคู่มือสไตล์ของคุณไว้ที่ไหน?

คุณไม่ควร ตัดสินใจ เพียงแค่นี้ คุณต้องจดบันทึกลงในที่ปลอดภัยด้วย

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

แต่ถ้าคุณชอบวิธีอื่น ให้เลือกสิ่งที่คุณคุ้นเคย สิ่งสำคัญเพียงอย่างเดียวคือสิ่งนี้:

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

ดังนั้น ลงกระดาษแล้วเริ่มสร้างบทความฐานความรู้ที่สอดคล้องกันมากขึ้น!