หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- TheGoodDocsProject
- ผู้เขียนด้านเทคนิค:
- Loquacity
- ชื่อโปรเจ็กต์:
- คู่มือสถาปัตยกรรมข้อมูล
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
แผนแนะนำสถาปัตยกรรมข้อมูล
เอกสารนี้ครอบคลุมการวางแผนสำหรับคู่มือสถาปัตยกรรมข้อมูลสำหรับโครงการ Good Docs ซึ่งเป็นส่วนหนึ่งของการส่ง Google ซีซันของเอกสาร 2020 โดยจะสรุปกรณีการใช้งานของคู่มือที่เสนอ และร่างแผนโครงสร้างของคู่มือดังกล่าวเพื่อวัตถุประสงค์ในการวางแผน
สถาปัตยกรรมข้อมูล (IA) เกี่ยวข้องกับวิธีการจัดระเบียบเนื้อหา ซึ่งบดบังโครงสร้างของเนื้อหาโดยไม่กำหนดรูปแบบหรือคำที่ใช้ภายในเนื้อหา ตัวอย่างเช่น แผน IA จะพิจารณาว่าใครเป็นผู้อ่าน เข้าถึงเนื้อหาอย่างไร และสภาพแวดล้อมที่ผู้อ่านอ่านอยู่ จากนั้นจึงพิจารณาโครงสร้างที่เหมาะสมสำหรับเนื้อหาที่จะตอบสนองความต้องการของผู้อ่านเหล่านี้ได้ดีที่สุด
โลกที่สมบูรณ์แบบ เอกสารได้รับการออกแบบโดยเริ่มจากกลยุทธ์เนื้อหา ซึ่งใช้เป้าหมายทางธุรกิจในการกำหนดเป้าหมายของเอกสาร จากนั้นจึงใช้กลยุทธ์เนื้อหาเพื่อสร้าง IA ซึ่งระบุเลย์เอาต์และโครงสร้างของเอกสาร จากนั้นคุณจะเลือก Toolchain และเขียนเนื้อหาได้ ความเป็นจริงของโปรเจ็กต์โอเพนซอร์สส่วนใหญ่คือกลยุทธ์ด้านเนื้อหานั้นง่ายมาก เพียง "เขียนเอกสารประกอบเพื่อให้ผู้คนรู้วิธีใช้โครงการนี้" แต่กลยุทธ์ง่ายๆ นั้นก็เพียงพอสำหรับการให้คำจำกัดความ IA ที่มีประสิทธิภาพ
จุดประสงค์ของคู่มือนี้คือให้เครื่องมือที่ใช้งานง่ายสำหรับนักเขียนที่ไม่ได้มืออาชีพเพื่อพัฒนา IA ที่เพียงพอต่อการพิจารณาว่าควรใช้เทมเพลตใด ซึ่งน่าจะไม่ซับซ้อนมากพอที่มนุษย์ทั่วไปจะเขียนให้เสร็จในช่วงบ่าย และควรสนับสนุนการกระทำมากกว่าการศึกษา ตามหลักแล้ว จะเป็นการแนะนำแนวคิดที่กระชับ แนะผู้อ่านให้พิจารณาแนวคิดเหล่านั้นโดยสัมพันธ์กับโครงการของตน และนำผลลัพธ์ที่ได้ไปพิจารณาในแนวคิดถัดไป
ในการสร้างโครงสร้างสำหรับโครงการนี้ จำเป็นต้องอัปเดตโครงการ README บางอย่างเพื่อให้ผู้อ่านเข้าใจวิธีเริ่มต้นใช้งานโครงการ Good Docs และสามารถใช้คู่มือ IA เพื่อเป็นแนวทางในการเลือกเทมเพลตได้อย่างมีประสิทธิภาพ
กลุ่มเป้าหมายหลัก
ทุกคนที่ต้องการใช้เทมเพลตโครงการ The Good Documents เพื่อสร้างเอกสารประกอบสำหรับโปรเจ็กต์ของตนเอง
กรณีการใช้งาน: ส่วนนี้ออกแบบมาเพื่อสำรวจวิธีที่ผู้อ่านเข้าถึงคู่มือ IA ซึ่งจะช่วยให้เราระบุโครงสร้างของคู่มือเพื่อนำเสนอแก่ผู้อ่านเหล่านั้นได้อย่างดีที่สุด
สถานการณ์:
บุคคลหนึ่งกำลังทำโครงการโอเพนซอร์สที่มีเอกสารประกอบเพียงเล็กน้อยหรือไม่มีเลย หรือชุดเอกสารที่ไม่ได้จัดระเบียบหรือเขียนขึ้นอย่างไม่เหมาะสม พวกเขาตัดสินใจใช้ The Good Documents ในการจัดระเบียบเอกสาร แต่ไม่แน่ใจว่าจะเริ่มต้นจากตรงไหน พวกเขาปฏิบัติตาม README เพื่อทำความเข้าใจวิธีเริ่มต้นใช้งานเทมเพลต และติดตาม Information Architecture Guide เพื่อพัฒนากลยุทธ์เนื้อหาและวางแผนว่าชุดเอกสารจะมีลักษณะอย่างไร
ข้อเสนอ
อัปเดต README เพื่อชี้นำผู้อ่านรายใหม่ผ่านโปรเจ็กต์ได้ชัดเจนยิ่งขึ้น รวมถึงในขั้นแรกที่ชัดเจน หนึ่งในขั้นตอนแรกคือการอ่านและเขียนคำถามใน IA Guide ใหม่ คู่มือนี้จะเชิญชวนให้ผู้อ่านพิจารณาผู้ชม สคีมาเนื้อหา เมทริกซ์ผู้ใช้/งาน ฯลฯ โดยไม่เพิ่มภาระให้กับผู้อ่านมากเกินไปในการเรียนรู้/ทำความเข้าใจสิ่งเหล่านั้นในทางวิชาการ เมื่องานนี้เสร็จสิ้น ผู้อ่านจะเข้าใจว่าเทมเพลตใดที่จำเป็นและจะนำมาใช้อย่างไรจึงจะดีที่สุด
การค้นคว้า
เพื่อเป็นการสำรองงานวิจัยนี้ ผมจะเน้นใช้หนังสือของ Abby Covert (http://www.howtomakesenseofanymess.com/) ส่วนหนึ่งเป็นเพราะฉันคุ้นเคยกับหนังสือเล่มนี้เป็นอย่างดีและทำให้เกิดพื้นฐานของเนื้อหาจำนวนมากที่ฉันเขียนไว้แล้ว และจะนำมาใช้ประโยชน์ แต่ก็เป็นเพราะใครๆ ก็เริ่มสนใจ IA ที่จะมาอ่านต่อไปได้ง่ายมาก มันก็แค่ยาเกตเวย์ไอเอนะ
ToC ฉบับร่าง
README:
-- ข้อมูลเบื้องต้นเกี่ยวกับโครงการเอกสารที่ดี |_ ใครควรใช้เทมเพลต |_ เทมเพลตทำงานอย่างไร |_ มีส่วนร่วมในโครงการ -- เทมเพลต |_ รายการเทมเพลตปัจจุบันทั้งหมด |_ เลือกว่าจะใช้เทมเพลตใด |_ ก่อนเริ่มต้น -- ก่อนจะเริ่มเขียน |_ ใครอ่านเอกสารบ้าง |_ ทำไมพวกเขาจึงอ่านเอกสารนี้ |_ การเขียนสำหรับผู้อ่าน
คู่มือ IA:
-- บทนำ |_ IA คืออะไร |_ เหตุใดฉันจึงควรสนใจ -- ระบุความยุ่งเหยิง -- ระบุความตั้งใจของคุณ -- ใบหน้าจริง -- เลือกทิศทาง -- วัดระยะทาง -- เล่นกับโครงสร้าง -- เตรียมตัวปรับ