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