สิ่งกีดขวางบนถนนเผชิญกับกระบวนการพัฒนาในการใช้ภาษามาร์กอัปข้อความธรรมดาซึ่งตรงกันข้ามกับเช่น Microsoft Word [ปิด]

ขณะนี้ฉันฝึกงานที่ผู้รับเหมาของรัฐบาลและฉันรู้สึกว่า (Word เป็นมาตรฐานจริงในกระบวนการพัฒนาซอฟต์แวร์)

รูปแบบไบนารีของมันทำให้ยากมากที่จะทำงานร่วมกันในเอกสารในแบบที่ฉันคุ้นเคยกับการทำงานร่วมกันบนฐานรหัส การใช้มาร์กอัปข้อความธรรมดา (ที่มีภาษาเช่น LaTeX, Markdown, ReStructured Text ฯลฯ ) ช่วยให้เอกสารที่เป็นมิตรแตกต่างที่ทำงานได้ดีกับเวิร์กโฟลว์ปกติของนักพัฒนา ในฐานะที่เป็นสำหรับความคิดเห็นที่ภาษาไม่สนับสนุนพวกเขา (เช่น Markdown) มีโซลูชั่นที่มีอยู่มากมายที่ช่วยให้การแสดงความคิดเห็นร่วมกันบนฐานรหัส (เช่น GitHub, Bitbucket) ที่สามารถได้อย่างง่ายดายนำไปใช้กับไฟล์ข้อความธรรมดาอื่น ๆ ที่มีมาร์กอัป

ฉันเข้าใจความต้องการที่จะร่วมมือกับการจัดการที่ไม่รู้หนังสือเกี่ยวกับเทคโนโลยีจำเป็นต้องมีส่วนต่อประสานกราฟิกทุกอย่าง แต่ส่วนต่อประสานดังกล่าวมีอยู่สำหรับรูปแบบเหล่านี้ส่วนใหญ่ ตัวอย่างเช่น LaTeX มี 'fork' ของการเรียงลำดับที่เรียกว่า LyX ที่ทำให้ front-end แบบกราฟิกเป็นข้อความธรรมดา, LaTeX-syntax ไฟล์นี้แม้จะเป็นกราฟิกในการแก้ไขเป็นหลัก แต่ก็ยังเป็นมิตร (นอกจากนี้ยังมีความคิดเห็นสไตล์ Word) โซลูชันเหล่านี้จำนวนมากยังไม่สามารถใช้แทน Word ได้และส่วนใหญ่เป็นฟรีหรือโอเพ่นซอร์ส

อย่างไรก็ตามเราใช้ Word แม้สำหรับเอกสารภายในของเราที่ไม่มีใครเห็น เราทำงานกับข้อความเพื่อแสดงถึงอาชีพที่สำคัญของเรา --- ทำไมเอกสารถึงพิเศษมาก? นอกเหนือจากเรื่องเล็กน้อย "เราไม่รู้อะไรดีกว่าและตอนนี้เราติดอยู่ที่นี่" ต้องมีเหตุผลสนับสนุนการตัดสินใจเช่นนี้ ความท้าทายใดที่เผชิญกับกระบวนการพัฒนาซอฟต์แวร์ในการใช้เอกสารที่เป็นข้อความล้วนแทนการใช้ภาษาอื่น ๆ (และมีประสิทธิภาพน้อยกว่า debatably) ในการเขียนเอกสาร?

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

การใช้เอกสารข้อความธรรมดาตั้งแต่เริ่มต้น
โยกย้ายไปยังเอกสารข้อความธรรมดาเมื่อเวลาผ่านไป

development-process documentation

— ฌอน Allred
แหล่งที่มา

ด้วยเหตุผลอิสระคุณควรโยกย้ายไปยัง Word เวอร์ชันใหม่ (office 2007 / 12.0 ขึ้นไป) ซึ่งมีรูปแบบเอกสารที่ใช้ xml เวอร์ชันล่าสุดของ openoffice และ libreoffice โดยเฉพาะอาจเป็นตัวเลือกที่ดียิ่งขึ้น - ตัวกรองการนำเข้า / ส่งออกช่วยให้สามารถทำงานร่วมกับเวิร์กโฟลว์ที่ใช้คำ MS ได้อย่างราบรื่น ยิ่งไปกว่านั้นการทำงานกับภาษามาร์กอัปในการสร้างหน้าเว็บต้องการระดับที่สูงขึ้นของนามธรรมและโครงสร้างความคิดที่ดีขึ้นก่อนหน้านี้ในขณะที่ไม่สนับสนุนการเขียนเชิงสำรวจอย่างง่ายดาย และแน่นอน ms office ui นั้นเป็นธรรมเนียม - ไม่จำเป็นต้องมีการฝึก

— collapsar

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

— vaughandroid

ในฐานะที่เป็น collapsar ชี้ให้เห็นว่าเอกสารคำ XML ที่ใช้เป็นเรื่องง่ายมากที่โปรแกรมสำหรับ (openxml sdk, ... (ฉันสามารถแนะนำ ClosedXML และ Novasoft.DocX สำหรับ c #) เมื่อมาจากพื้นเพวิชาการ TEX อาจดูดี แต่ถ้าไม่ - ใครใช้มันก็ดีเหมือนกันเส้นโค้งการเรียนรู้สูงเกินไป! แม่และคุณยายของคุณอาจรู้ว่าคำคืออะไรถามพวกเขาเกี่ยวกับ TEX ฉันจะประหลาดใจ!

— Mvision

และสำหรับ UI ที่ใช้งานง่ายนี่เป็นความจริงสำหรับกลุ่มเวิร์กโฟลว์ระดับปกติที่ดี แต่แบ่งย่อยเพื่อสิ่งที่ซับซ้อนยิ่งขึ้น ดูsuperuser.com/questions/620454และโปรดทราบว่าวิธีการอัปเดต TOC คือการแทรกอันใหม่ที่อยู่ตรงกลางและรอป๊อปอัป วิธีเพิกเฉยต่อการสะกดคำอย่างต่อเนื่องสำหรับข้อความจำนวนหนึ่งคือการตั้งค่าภาษา <-null เป็นของใช้งานง่ายนี้หรือไม่? แต่นี่คือนอกเหนือจากจุด ข้อความล้วนเปิดเผยโครงสร้างและเนื้อหาของเอกสารอย่างสมบูรณ์ ไม่มีระเบียบไม่มีความยุ่งยาก

— ฌอน Allred

@rath แน่นอน หากทุกคนหวังว่าจะนำความคิดของเด็ก ๆ ไปสู่ด้านมืดความคิดเห็น / คำตอบสำหรับลิงก์นั้นจะช่วยให้คุณเริ่มต้นได้ (โดยเฉพาะการนำเสนอของ Jubobs --- เขาอัปโหลดไฟล์เก็บถาวรและมันก็ดีมาก)

— Sean Allred

คำตอบ:

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

เหนือสิ่งอื่นใดนักพัฒนาที่ไม่ใช่นักพัฒนาจำนวนมากได้ใช้เวลาหลายปีในมหาวิทยาลัยโดยใช้ Microsoft Word เพื่อเปลี่ยนงานของพวกเขาบ่อยครั้งที่มีชั้นเรียนฝึกอบรมจริงในการใช้คำ พวกเขารู้ดีกว่าทางเลือกอื่น ฉันแทบจะไม่สามารถบอกความแตกต่างได้เมื่อฉันทำงานใน Open Office กับ Word แต่เมื่อฉันมีพี่สะใภ้ใช้มันเพื่อประหยัดเงินอีกหนึ่งสัปดาห์ต่อมาเธอให้สามีของเธอซื้อ Word ของเธอแล้วประกาศว่า แล็ปท็อปเครื่องใหม่ของฉัน! " คิดเกี่ยวกับความคิดที่ทำให้สิ่งต่าง ๆ เป็นแบบนั้นการเปลี่ยนแปลงเล็กน้อยในสิ่งที่พวกเขาคุ้นเคยไม่ได้ 'เล็กน้อย' กับพวกเขา

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

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

— จิมมี่ฮอฟฟา
แหล่งที่มา

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

— nietonfir

@nietonfir ว้าวมันเป็นประสบการณ์ของฉันที่คำว่าทุก PM และ QA บุคคลที่ชื่นชอบ (อ่าน: เท่านั้น) เครื่องมือ

— Jimmy Hoffa

@JimmyHoffa มันเป็น แต่ส่วนใหญ่ไม่ทราบวิธีการใช้ Word อย่างถูกต้อง (เช่นดัชนี, คำบรรยายภาพ, ส่วนหัวของหน้าแรก, ตัวเลข, ส่วนหัว, ... )

— nietonfir

@JimmyHoffa: ใช่ แต่พวกเขาได้รับการฝึกอบรมเท่าไหร่? และพวกเขาใช้ฟังก์ชั่นของ Word มากแค่ไหน? IMHO ผู้ใช้ส่วนใหญ่สามารถสลับไปใช้ WordPad ได้อย่างง่ายดาย

— Reinstate Monica - M. Schröder

โอ้สวัสดี @ MartinSchröder :-) สำหรับ WordPad ขณะที่ส่วนใหญ่ของการเขียนเนื้อหาอาจจะไม่ทราบวิธีการใช้ MS Word เพื่อ 'ศักยภาพ' อย่างเต็มรูปแบบไม่กี่ของพวกเขาทำ จากประสบการณ์ของฉันมันเป็นชุดเล็ก ๆ ของผู้ใช้ระดับสูงที่ตั้งค่าเอกสาร (ซ้ำแล้วซ้ำอีก) สำหรับผู้ใช้ที่เพิ่มจำนวนมากของเนื้อหา เมื่อมีคนต้องการเพิ่มรูปความคิดเห็นจะถูกเพิ่ม (การบำรุงรักษาเอกสารเป็นเอกสารอย่างน้อยก็กลายเป็นงานนอกเวลา)

— Sean Allred

ส่วนตัวฉันคิดว่ามันเป็นปัญหาของการศึกษา

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

เครื่องมืออย่างScrivenerช่วยให้คุณสามารถใกล้ชิดกับความเป็นจริงของเอกสารได้มากขึ้นโดยไม่ต้องต่อสู้กับมันเหมือนกับที่คุณทำกับ Word ส่วนหนึ่งเป็นเพราะการใช้ WYSIWYG นั้นใช้งานได้ไม่ดีนัก

ในองค์กรของฉันคนที่ฉันย้ายไปใช้ MarkDown สำหรับเอกสารส่วนใหญ่ของพวกเขาต้องการคนที่มีความสุขและมีประสิทธิผลมากขึ้น

— aboy021
แหล่งที่มา

คุณแนะนำจริง ๆ ว่า "debug" LaTeX ง่ายกว่า MS Word หรือไม่

— user253751

@immibis LaTeX3 รู้ว่านี่เป็นปัญหา (แม้แต่ LaTeX2e แต่มันล้มเหลวในการหาจุดข้าม) เป็นการดีที่ไม่มีการเข้ารหัสในระดับเอกสาร (เปิดเผยต่อผู้แต่ง) 'การดีบัก' ทั้งหมดจะทำในระดับรหัสซึ่งคุณมีคนที่คุ้นเคยกับภาษาที่ใช้งานได้ Trust me, expl3ข้อความผิดพลาดเป็นมากเพิ่มเติมที่เป็นประโยชน์ :)

— ฌอน Allred

@immibis ในความเป็นจริงแล้วการ "debug" LaTeX ง่ายกว่า MSWord มีการจัดรูปแบบ quirks ใน MSWord ซึ่งไม่สามารถแก้ไขได้โดยใครโดยไม่ต้องแก้ไขโปรแกรม MSWord เอง ในกรณีเหล่านี้คุณสามารถใช้เวลาตลอดเวลาที่คุณต้องเรียนรู้ LaTeX -> TeX -> C -> Assembler แต่คุณต้องไปลึก ฉันรู้ว่าผู้ใช้นอกเขตพัฒนาซอฟต์แวร์ที่มีความรู้ในการทำงานที่ดีเกี่ยวกับ LaTeX และสิ่งต่าง ๆ เช่น pstricks พวกเขาเลือก LaTex มากกว่า Word ทุกครั้ง พวกเขาใช้ ไม่ทำการดีบั๊กที่ซับซ้อนพวกเขาแค่ขอความช่วยเหลือจากใครสักคนซึ่งเกิดขึ้นไม่บ่อยนักกับ MSWord

— wolfmanx

คุณมีคำถาม 2 ข้อจริง ๆ :

ครั้งแรก: ทำไมกลุ่มที่ไม่ใช่ผู้พัฒนาไม่ใช้ LaTeX หรือ Markdown อื่น ๆ ในกระบวนการพัฒนาซอฟต์แวร์

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

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

คำถามที่สอง: ทำไมทีมของฉันยังคงใช้เอกสารคำต่อเมื่อมีตัวเลือกที่ดีกว่าและพวกเขามีความสามารถในการเรียนรู้มากกว่าพวกเขา?

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

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

— Stoj
แหล่งที่มา

สิ่งนี้ไม่แม้แต่จะพยายามตอบคำถามที่ถามว่า "ทำไมภาษามาร์กอัปข้อความธรรมดา (เช่น LaTeX หรือ Markdown) จึงไม่เป็นที่นิยมในกระบวนการพัฒนาซอฟต์แวร์"

— ริ้น

+0 แต่เห็นด้วย - นี่น่าจะเหมาะสมกว่าสำหรับความคิดเห็น

— Sean Allred

หลังจากแก้ไขคำถามแรกมันก็ดีขึ้นมาก @ คาดอีกอย่างเป็นระเบียบ

— ฌอน Allred