ตัวอย่างกรณีศึกษาของ Season of Docs

ระยะปัจจุบัน:
โปรแกรมเอกสารซีซัน 2021 สิ้นสุดลงเมื่อวันที่ 14 ธันวาคม 2021 ดูไทม์ไลน์

ใช้ตัวอย่างนี้เพื่อช่วยคุณสร้างรายงานกรณีศึกษาของคุณเอง

PicklePlus: จัดทำเอกสารเกี่ยวกับเครื่องมือการมีส่วนร่วม Glorious Pickle

องค์กรหรือโปรเจ็กต์: Glorious Pickle ลิงก์ไปยังเว็บไซต์หลักขององค์กรหรือโครงการที่นี่

คำอธิบายขององค์กร: Glorious Pickle (เวอร์ชัน 1.2.3 ที่เปิดตัวครั้งแรกในปี 2009) เป็นห้องสมุดที่ได้รับอนุญาตจาก MIT สำหรับการคำนวณอัตราส่วนของเกลือ น้ำตาล น้ำส้มสายชู และเครื่องเทศที่สมบูรณ์แบบสำหรับผักที่ดองทุกชนิดในปริมาณได้ตั้งแต่แตงกวาลูกเดียวไปจนถึงหัวไชเท้าในบรรจุภัณฑ์บนเรือ

ผู้เขียน: ไม่บังคับ: แสดงรายชื่อผู้เขียนกรณีศึกษา แต่ใช้ชื่อผู้ใช้หากมีการร้องขอ

การแถลงปัญหา/นามธรรมของข้อเสนอ

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

การเพิ่มส่วนผสมลงในฐานข้อมูลส่วนประกอบของเครื่องมือ Glorious Pickle ใช้เวลานานและมีความซับซ้อน เครื่องมือจึงไม่มีเอกสารประกอบที่ดี ผู้ที่มีส่วนร่วมหลายคนไม่มีประสบการณ์ในการใช้ Git หรือการส่งคำขอพุล วิธีนี้ทำให้ Glorious Pickle มีช่องว่างอย่างมากในข้อมูลส่วนผสม การปรับปรุงเอกสารประกอบการเพิ่มส่วนผสมใหม่ๆ จะช่วยสนับสนุนผู้มีส่วนร่วมใหม่ๆ และการดองมากขึ้น

คำอธิบายโปรเจ็กต์

การสร้างข้อเสนอ

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

Glorious Pickle PickleDocuments SIG เพื่อแจ้งเกี่ยวกับโปรแกรม Season of Docs ผ่านทางทวีตจากสำนักงานโปรแกรมโอเพนซอร์สของ Google SIG จะพูดคุยเรื่องโปรแกรมในการประชุมทุก 2 สัปดาห์และตกลงที่จะสร้างข้อเสนอ สมาชิก 2 คนของ SIG (@KimChiCook และ @Dillicious) อาสาทำงานร่างข้อเสนอเพื่อนำไปตรวจสอบในการประชุมครั้งต่อไป

เมื่อ PickleGoogle SIG ในการตอบตกลงเกี่ยวกับร่างข้อเสนอ ก็ได้มีการส่งอีเมลไปยังโครงการส่วนกลางเพื่อขอความคิดเห็น สมาชิกชุมชน 14 คนได้แสดงความคิดเห็น ซึ่งรวมถึง @Glorious PicklePat ผู้ดูแลรักษา API การเพิ่มส่วนผสม @Glorious PicklePat อาสาเป็นแหล่งข้อมูลร่วมโปรแกรม

หลังจากพูดคุยและนำความคิดเห็นที่ได้รับไปพิจารณาแล้ว ข้อเสนอจะถูกส่งไปยังคณะกรรมการกำกับดูแลโครงการ Glorious Pickle เพื่อพิจารณาโหวต สมาชิกทั้ง 5 คนของ GPPSC ได้โหวต +1 ให้ส่งข้อเสนอและการสมัคร และ @VinegarViv ก็ตกลงที่จะช่วยสร้างบัญชี Open Collective ที่จำเป็นสำหรับการเข้าร่วมโปรแกรมและดูแลการชำระเงิน

งบประมาณ

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

สมาชิก 2 คนของ SIG ของ Glorious Pickle Pickleไดรฟ์และเอกสาร เป็นนักเขียนเชิงเทคนิค (1 รายในยุโรป ส่วนอีก 1 รายอยู่ในอาร์เจนตินา) ผู้เชี่ยวชาญเหล่านี้ช่วยเราประเมินงานและหางบประมาณของโครงการที่คล้ายกัน โดยเปรียบเทียบงานร่างข้อเสนอที่พวกเขาเคยทำก่อนหน้านี้ เรายังมีเงินเหลือ$1,000 เป็นเงินผู้สนับสนุนแบบไม่จำกัดจากการประชุม PicklePals ปี 2019 ซึ่งจัดสรรให้โครงการ

ค่าใช้จ่ายที่ไม่คาดคิดคือการช่วยนักเขียนด้านเทคนิคเช่าฮอตสปอต Wi-Fi เนื่องจากอยู่ในพื้นที่ที่ได้รับผลกระทบจากไฟป่าและไม่สามารถเข้าถึงอินเทอร์เน็ตที่บ้านได้ นอกจากนี้ เรายังส่งเสื้อยืดให้ผู้เข้าร่วมน้อยกว่าที่วางแผนไว้ ซึ่งทำให้มีความสมดุล

นอกจากนี้ เรายังตัดสินใจมอบค่าตอบแทนให้กับ @Piccalily (ซึ่งเคยเป็นนักเขียนก็อปปี้ไรท์เตอร์มืออาชีพ) เพื่อช่วยแก้ไขการคัดลอกและการพิสูจน์อักษรในเอกสารที่สร้างโดยนักเขียนด้านเทคนิค

ผู้เข้าร่วม

ใครที่ทำงานโครงการนี้ (โปรดใช้ชื่อผู้ใช้หากผู้เข้าร่วมขอ) คุณค้นพบและว่าจ้างนักเขียนเชิงเทคนิคอย่างไร คุณพบอาสาสมัครหรือผู้เข้าร่วมแบบชำระเงินคนอื่นๆ อย่างไร เขามีบทบาทอะไร มีใครลาออกจากบ้านไหม คุณได้เรียนรู้อะไรบ้างเกี่ยวกับการสรรหา การสื่อสาร และการบริหารโครงการ

ทีมหลักที่ดำเนินการในโปรเจ็กต์นี้ ได้แก่

  • @Dillicious, @KimChiCook (เลือกเอกสาร SIG)
  • @Piccalily (ก็อปปี้บรรณาธิการ)
  • @GherKen, @VinegarViv (ความช่วยเหลือสำหรับผู้ดูแลระบบ, GPPSC)
  • @BBChips, @Glorious PicklePat (ผู้เชี่ยวชาญเนื้อหาเฉพาะ)
  • Sam Scribe (นักเขียนด้านเทคนิค)

เราพบ Sam Scribe ผ่านรายการซีซันของที่เก็บ GitHub ของเอกสาร เราคิดว่าประสบการณ์ของพวกเขา (Sam เคยทำงานให้กับนิตยสารเกี่ยวกับการทำอาหารและการเขียนเอกสารประกอบสำหรับเว็บไซต์) นั้นเหมาะกับโครงการของเรา Sa เรายังได้ติดต่อนักเขียนด้านเทคนิคอีก 2 คนที่รู้จักเราผ่านเครือข่ายของสมาชิก SIG แต่ก็ไม่ได้พูดคุยเรื่องนี้ตลอดระยะเวลาของโปรแกรมด้วย

เนื่องจากเขตเวลาของ Sam จะทับซ้อนกันกับสมาชิกส่วนใหญ่ของ PickleGoogle SIG ไม่กี่ชั่วโมงเท่านั้น เราจึงส่ง การโทรติดต่อไปยัง Picklers ซึ่งอยู่ในเขตเวลาของ Sam และคุ้นเคยกับกระบวนการเพิ่มส่วนผสม @BBChips อาสาตอบคำถามแทนแซมและช่วยค้นหาผู้เชี่ยวชาญคนอื่นๆ ที่จำเป็น @Glorious PicklePat อาสาช่วยแซมเข้าใจสถาปัตยกรรมที่สำคัญของเครื่องมือ รวมถึงข้อความแสดงข้อผิดพลาดที่อาจเกิดขึ้นจาก API รวมถึงให้ความช่วยเหลือ GitHub และ git ด้วย

แต่น่าเสียดายที่ในช่วงกลางรายการ @VinegarViv ต้องย้อนจากโปรเจ็กต์ไปด้วยเหตุผลส่วนตัว @GherKen สมาชิก GPPSC ได้เข้ามาช่วยตอบคำถามเกี่ยวกับการดูแลระบบและการชำระเงิน

หลังจากตอบผิดบางข้อ (Glorious Pickle ใช้อินสแตนซ์ Slack ที่ไม่เสียค่าใช้จ่าย และในบางครั้ง การสนทนาดำเนินไปอย่างรวดเร็วจนเราสูญเสียการสนทนาไปเนื่องจากขีดจำกัดการเก็บใหม่) เราได้ทราบว่าควรเก็บรายการคำถามที่ยังดำเนินอยู่ในเอกสารที่แชร์ไว้ (เราใช้ Google เอกสารที่แชร์กัน) สมาชิก SIG ของ PickleDocuments ตรวจสอบเอกสารดังกล่าวก่อนการประชุมแต่ละครั้ง และดูให้แน่ใจว่าได้รับคำตอบก่อนสิ้นสุดการประชุม Sam สามารถ ping @BBChips โดยตรงสำหรับคำถามเร่งด่วน

เราดีใจมากที่ได้ร่วมงานกับ Sam และ Sam ไม่เพียงแค่อัปเดตเอกสารประกอบ Glorious Pickle แล้ว ก็ยังเป็นแฟนพันธุ์แท้ด้วยเช่นกัน

ไทม์ไลน์

แสดงภาพรวมสั้นๆ เกี่ยวกับไทม์ไลน์ของโปรเจ็กต์ (ระบุวันที่สิ้นสุดโดยประมาณหรือเป้าหมายระดับกลางหากโปรเจ็กต์ดำเนินอยู่)

ขณะที่เรารอโปรแกรม Season of Docs เพื่อประกาศองค์กรที่เข้าร่วม สมาชิก SIG ของ PickleGoogle ได้ค้นหาผลงานก่อนหน้าที่เราคิดว่าจะเป็นประโยชน์กับ Sam ตลอดช่วง 1 เดือน เราพบบันทึกบางรายการจากความพยายามอัปเดตเอกสารที่อาจหยุดชะงักก่อนหน้านี้ และเรายังดำเนินการกับเนื้อหาการตรวจสอบวุฒิภาวะบางส่วนในที่เก็บ Opendocs ของ Google ด้วย

เมื่อได้รับข่าวดีว่าเราได้รับเลือกสำหรับฤดูกาลในเอกสารปี 2021 Sam และ SIG ของ PickleGoogle ได้ประชุมกันและร่างกำหนดการคร่าวๆ ดังนี้

ระยะทำงาน เสร็จสมบูรณ์โดย
ตรวจสอบการตรวจสอบเอกสาร 7 พฤษภาคม
กรณีการใช้งานบันทึกข้อผิดพลาด 3 14 พฤษภาคม
ดูบันทึกอุปสรรคด้วย @Glorious PicklePat และ @BBChips เพื่อตอบคำถาม 28 พฤษภาคม
กรณีการใช้งานที่ 1 ฉบับร่างแรกของเอกสารที่อัปเดต 25 มิถุนายน
ฉบับร่างกรณีการใช้งานที่ 1 ตรวจสอบโดย @Glorious PicklePat และ @KimChiCook 2 กรกฎาคม
กรณีการใช้งานที่ 2 สำหรับฉบับร่างแรกของเอกสารที่อัปเดต 2 กรกฎาคม
ฉบับร่างกรณีการใช้งานที่ 2 ตรวจสอบโดย @Glorious PicklePat และ @Dillicious 9 กรกฎาคม
กรณีการใช้งานที่ 3 สำหรับฉบับร่างแรกของเอกสารที่อัปเดต 9 กรกฎาคม
ฉบับร่างสำหรับกรณีการใช้งานที่ 3 ตรวจสอบโดย @Dillicious และ @KimChiCook 16 กรกฎาคม
ตอบคำถามทั้งหมดในทุก Use Case แล้ว 30 กรกฎาคม
SIG ส่วนใหญ่ของ PickleDocument ในวันหยุดพักผ่อนระหว่างวันที่ 1-20 ส.ค. --
เริ่มการทดสอบเอกสารใหม่ในชุมชน (เอกสารที่เผยแพร่เป็นฉบับร่างในเว็บไซต์ Glorious Pickle) 21 สิงหาคม
รวมความคิดเห็นเกี่ยวกับการทดสอบ 10 กันยายน
คัดลอกและพิสูจน์อักษรเอกสารใหม่ 17 กันยายน
สถานะฉบับร่างของเอกสารถูกนำออก เอกสารเปิดตัวอย่างเป็นทางการแล้ว 28 กันยายน
กระบวนการอัปเดตเอกสารที่สร้าง 1 พฤศจิกายน
กรณีศึกษานี้สร้างขึ้น 8 พฤศจิกายน
ส่งกรณีศึกษาแล้ว 16 พฤศจิกายน

ในงบประมาณข้อเสนอของเรา เราได้คาดการณ์ว่านักเขียนด้านเทคนิคจะใช้เวลา 10-15 ชั่วโมงต่อสัปดาห์เพื่อทำโครงการ Sam เก็บบันทึกเวลาที่ใช้และเฉลี่ย 11.5 ชั่วโมงต่อสัปดาห์

ผลลัพธ์

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

กรณีการใช้งานหลัก 3 อย่างจะได้รับการจัดทำเป็นเอกสารคำแนะนำวิธีใช้ฉบับเต็มสำหรับผู้ใช้ ดังนี้

วิธีเพิ่มส่วนผสมใหม่ลงใน Glorious Pickle

วิธีเพิ่มส่วนผสมของตัวแปรลงใน Glorious Pickle

วิธีอัปเดตหรือแก้ไขส่วนผสมใน Glorious Pickle

คำแนะนำเหล่านี้มีเทมเพลตการดึงคำขอใหม่เพื่อให้การสนับสนุนง่ายขึ้น

นอกจากนี้ ในระหว่างดำเนินโครงการ Sam ได้สร้างอภิธานศัพท์เกี่ยวกับ Pickle ขนาดเล็กจากคำศัพท์ที่ได้เรียนรู้ ซึ่งได้รับการเผยแพร่ในเว็บไซต์โครงการ Glorious Pickle ด้วย

เราได้เพิ่มคำแนะนำในการอัปเดตคำแนะนำวิธีใช้ของผู้ใช้เหล่านี้ลงใน Wiki ของโปรเจ็กต์

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

เมตริก

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

ในข้อเสนอของเรา เราได้เสนอเมตริก 2 รายการ ได้แก่

  • จำนวนคำขอพุลที่เกี่ยวข้องกับส่วนผสม
  • จำนวนคำขอพุลจากผู้ร่วมให้ข้อมูลรายใหม่

ในเดือนกันยายน (เดือนแรกเต็มนับตั้งแต่ที่เผยแพร่เอกสารประกอบฉบับร่าง) เราพบว่ามีคำขอพุลที่เกี่ยวข้องกับส่วนผสมเพิ่มขึ้น 5% (จากวันที่ 20 สิงหาคมจนถึง 21 กันยายน) และเราพบผู้ร่วมให้ข้อมูลใหม่ 3 รายที่ส่งคำขอพุลทั้งหมด 4 รายการ (เทียบกับผู้ร่วมให้ข้อมูลรายใหม่ 2 รายที่สร้างคำขอพุล 2 รายการในเดือนสิงหาคม) เราวางแผนที่จะติดตามเมตริกเหล่านี้ทุกเดือน

ตั้งแต่วันที่ 1 มกราคมเป็นต้นไป เราจะติดตามจำนวนผู้ร่วมให้ข้อมูลที่ร่วมให้ข้อมูลมากกว่า 3 รายการโดยรวม โดยเริ่มทุกไตรมาสหลังจากเผยแพร่เอกสารแล้ว

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

การวิเคราะห์

มีอะไรบ้างที่เป็นไปด้วยดี มีอะไรที่ไม่คาดคิดบ้าง คุณเผชิญอุปสรรคหรืออุปสรรคอะไรบ้าง คุณคิดว่าโครงการประสบความสำเร็จไหม เพราะเหตุใด (หากยังบอกเร็วเกินไป ให้อธิบายว่าคุณจะตัดสินความสำเร็จของโครงการได้เมื่อใด)

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

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

เราได้เผชิญกับอุปสรรคที่ไม่คาดคิด 2-3 ข้อ เราดีใจที่ไฟป่าในรัฐของแซมไม่ได้สร้างความเสียหายไปกว่าสัญญาณอินเทอร์เน็ตขาดหายอีก! นอกจากนี้ เราเสียใจที่เสีย @VinegarViv ออกจากโครงการนี้ไป เราอวยพรให้เธอและครอบครัวของเธอประสบความสำเร็จ และหวังว่าจะได้พบกันอีกเร็วๆ นี้

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

สรุป

สรุปประสบการณ์การทำโครงการของคุณใน 2-4 ย่อหน้า ไฮไลต์สิ่งที่ได้เรียนรู้และสิ่งที่คุณเลือกที่จะทำที่แตกต่างออกไปในอนาคต คุณจะให้คำแนะนำอะไรแก่โครงการอื่นๆ ที่พยายามแก้ปัญหาที่คล้ายกันด้วยเอกสารประกอบ

พูดง่ายๆ ก็คือเรารู้สึกประหลาดใจมาก เราบรรลุเป้าหมายของสิ่งที่ส่งมอบตามเอกสารได้ และเมตริกต่างๆ ของเราก็ดูเหมือนจะสอดคล้องกับเป้าหมายของเรา

ส่วนสำคัญของความสำเร็จของโครงการนี้คือ เราโชคดีมากที่ได้ร่วมงานกับ Sam Scribe นักเขียนด้านเทคนิคของเรา [ฉันไม่ได้เขียนเรื่องนี้ Sam] แม้ว่า Sam จะไม่มีพื้นฐานด้านการดองหรือมีประสบการณ์กับ GitHub แต่ในฐานะนักเขียนด้านเทคนิคที่มีประสบการณ์ พวกเขาก็พร้อมที่จะเรียนรู้หัวข้อใหม่ ถามคำถาม และค้นคว้าข้อมูล Sam หยิบยกเครื่องมือโครงงานของเราได้อย่างรวดเร็ว (เราใช้กระดานคัมบังเพื่อติดตามงานด้วย) แต่ยังมีมุกตลกขำๆ ด้วย เราดีใจที่แซมจับข้อบกพร่องในการดองได้และ "ทำลาย" พวกมันในชุมชนของเรา

เราขอแนะนําให้โปรเจ็กต์อื่นๆ ทําดังนี้

  • ทำให้ข้อเสนอของคุณมีขนาดเล็กและจัดการได้ (เดิมทีเราต้องการแนบเอกสารเกี่ยวกับการใช้เครื่องมือประมาณค่ากับเครื่องจักรดองอุตสาหกรรมในข้อเสนอของเรา และเหลือไว้เพียงเพราะสมาชิกในชุมชนคนหนึ่งของเราที่มีส่วนร่วมอย่างหนักกับเครื่องจักรดงแบบโอเพนซอร์สกำลังเขียนวิทยานิพนธ์ระดับปริญญาเอกของเธอระหว่างในโปรแกรม) งานของเราล้นหลามจนทำให้แซมไม่ยอมพลาด
  • ใช้ประโยชน์จากเครือข่ายของคุณเมื่อมองหานักเขียนเชิงเทคนิค ขอคำแนะนำจากทุกคนในชุมชน แม้ว่าเราจะพบ Sam ผ่าน Season of Docs ใน GitHub แต่เราก็รู้สึกมั่นใจที่จะทำงานร่วมกับพวกเขาเนื่องจากเราได้พูดคุยกับหลายๆ คนในช่วงการสมัคร
  • ยินดีต้อนรับนักเขียนด้านเทคนิคเข้ามาในชุมชนของคุณ Sam บอกเราว่าทัศนคติที่กระตือรือร้นของ Glorious Pickler ช่วยให้ถามคำถามได้อย่างง่ายดาย
  • ช่วยให้นักเขียนเชิงเทคนิคได้รับทักษะโอเพนซอร์ส Sam ไม่เคยใช้ Git มาก่อน แต่หลังจากเรียนรู้บทแนะนำไปสัก 2-3 บทเรียน พวกเขาก็เรียนรู้ได้อย่างรวดเร็ว ตอนแรก Sam กังวลว่าจะได้รับความคิดเห็นจากชุมชนมากแค่ไหนและจะนำความคิดเห็นนั้นไปใช้อย่างไร แต่โมเดล 'ความเห็นพ้องอย่างคร่าวๆ ของชุมชน' ("บรรลุความเห็นพ้องเมื่อแก้ไขปัญหาทั้งหมดแล้ว แต่ไม่จำเป็นต้องรับรู้) ทำให้ Sam มั่นใจในการรับมือกับคำวิจารณ์โดยใช้ความเชี่ยวชาญในการเขียนเชิงเทคนิคขององค์กร

ภาคผนวก

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

บริการรับรองคำให้การ

ทีมของเราอยากทราบข้อมูลเกี่ยวกับบุคคลและสิ่งต่างๆ ต่อไปนี้

  • @Dillicious อยากขอบคุณแฟนของเธอและสถานีวิทยุฮิปฮอปโลว์ไฟ
  • @KimChiCook อยากขอบคุณ 할머니 ที่สอนวิธีดองเขา
  • @Piccalily อยากขอบคุณ Chicago Manual of Style Online
  • @GherKen อยากขอบคุณลูก 3 คนของเขาที่กินผักดองทุกอย่างที่ทำได้
  • @VinegarViv อยากขอบคุณคนอื่นๆ ในทีมที่ช่วยสนับสนุนเธอในการก้าวลงจากตำแหน่ง
  • @BBChips อยากขอบคุณอาหารที่ปราศจากดองที่ดีที่สุดอย่าง Caramel Wafers ของ Tunnock
  • @Glorious PicklePat ต้องขอบคุณ SIG ของ PickleGoogle ที่ดําเนินการในโครงการนี้
  • Sam Scribe อยากขอบคุณทุกคนในชุมชน Glorious Pickle โดยเฉพาะอย่างยิ่งชาว Pickler ที่ส่งโหลกระป๋องในช่วงที่ขาดแคลนโหลช่วงฤดูร้อนปี 2021 ซึ่งเป็นจุดเริ่มต้นของการเดินทางสู่ผักดองแสนอร่อยมากมาย