ไอเดียของโครงการ

ระยะปัจจุบัน:
โปรแกรม Season of Docs ปี 2019 จบลงแล้วเมื่อวันที่ 6 มีนาคม 2020 ดูไทม์ไลน์

แนวคิดของโครงการเป็นคำแนะนำจากองค์กรโอเพนซอร์สสำหรับโครงการต่างๆ ที่นักเขียนด้านเทคนิคสามารถทำร่วมกับที่ปรึกษาในระหว่างฤดูกาลของเอกสาร

ข้อมูลในหน้านี้มีไว้สำหรับผู้ดูแลระบบองค์กรแบบโอเพนซอร์สและ Mentor ที่กำลังเตรียมรายการแนวคิดของโครงการ ข้อมูลนี้ยังเป็นประโยชน์สำหรับนักเขียนด้านเทคนิคด้วย เนื่องจากมีพื้นฐานมาจากการมีส่วนร่วมขององค์กรใน Season of Docs

โปรเจ็กต์ตัวอย่าง

ตัวอย่างแนวคิดของโครงการประเภทที่นักเขียนด้านเทคนิคสามารถจัดการได้มีดังนี้

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

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

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

  • สร้างบทแนะนำสำหรับกรณีการใช้งานที่มีความสำคัญ

  • สร้างชุดคำแนะนำวิธีใช้ที่เจาะจงสำหรับงานใดงานหนึ่ง

  • สร้างคู่มือสำหรับผู้มีส่วนร่วมที่มีข้อมูลพื้นฐานเกี่ยวกับการเริ่มต้นในฐานะผู้มีส่วนร่วมกับโครงการโอเพนซอร์ส รวมถึงกฎใดๆ เกี่ยวกับข้อตกลงใบอนุญาต กระบวนการสำหรับการดึงคำขอและการตรวจสอบ การสร้างโครงการ และอื่นๆ

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

เป้าหมายของรายการข้างต้นคือการช่วยให้คุณเริ่มต้นใช้งาน คุณอาจเสนอโครงการประเภทอื่นๆ ได้ด้วย

เผยแพร่รายการแนวคิดโปรเจ็กต์ของคุณ

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

หน้าแนวคิดโปรเจ็กต์ของคุณควรมีข้อมูลต่อไปนี้

  • ข้อมูลเกี่ยวกับองค์กรโอเพนซอร์สของคุณ

    • ชื่อองค์กร
    • คำอธิบายองค์กร
    • ลิงก์ไปยังที่เก็บโอเพนซอร์สและ/หรือเว็บไซต์
    • (ไม่บังคับ) อีเมลสำหรับติดต่อองค์กรเกี่ยวกับฤดูกาลของเอกสาร ซึ่งควรเป็นอีเมลเดียวกับที่ระบุไว้ในแบบฟอร์มการสมัคร "ซีซันของเอกสาร" ขององค์กร
    • (ไม่บังคับ) ข้อมูลเกี่ยวกับการดูแลระบบและ Mentor ขององค์กร เช่น ชื่อที่แสดง ซึ่งควรเป็นชื่อเดียวกับชื่อที่แสดงซึ่งระบุไว้ในแบบฟอร์มใบสมัครขององค์กรสำหรับซีซันของเอกสาร

  • ประกาศที่องค์กรของคุณกำลังสมัครเข้าร่วม ฤดูกาลของเอกสารประจำปีนี้ หน้าโปรโมชันและข่าวมีโลโก้และเนื้อหาอื่นๆ ที่คุณสามารถใช้เมื่อพูดถึงซีซันของเอกสาร

  • แนวคิดของโปรเจ็กต์ รวมถึงข้อมูลที่อธิบายไว้ด้านล่างสำหรับแนวคิดของโปรเจ็กต์แต่ละรายการ

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

ข้อมูลในแนวคิดของแต่ละโปรเจ็กต์

แนวคิดของโครงการแต่ละรายการต้องมีข้อมูลต่อไปนี้เป็นอย่างน้อย

  • ชื่อโครงการ: เลือกชื่อที่สั้นกระชับแต่สื่อความหมาย
  • คำอธิบาย: คำอธิบายเอกสารแบบละเอียดสำหรับงานที่ต้องทำ อธิบายแนวคิดเริ่มต้นโดยละเอียด มอบโอกาสให้นักเขียนด้านเทคนิคที่สนใจ ได้ต่อยอดหรือปรับแต่งแนวคิด

  • เนื้อหาที่เกี่ยวข้อง

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

ความสำคัญของแนวคิดของโครงการ

แนวคิดของโครงการมีความสำคัญในหลายด้าน:

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