บทความ IT เจ๋งๆ
4 VS Code Extensions ที่ใช้แชร์ความรู้ Technical กับทีมของคุณได้
16-ก.ย.-22
คัมภีร์เทพ IT
VS Code เป็นหนึ่งใน Tools ที่ได้รับความนิยมเป็นอย่างมาก และแน่นอนว่าจุดเด่นของมันก็คือ การมี Extensions ที่ครอบคลุมการใช้งานที่หลากหลายวัตถุประสงค์สำหรับ Developers และบทความนี้ก็เป็น 4 VS Code Extensions ที่ใช้แชร์ความรู้ Technical กับทีมของคุณได้
Technical Documentation ปรากฏขึ้นเป็นครั้งแรกใน The DORA Report in 2021 ซึ่งพบว่ามีพื้นฐานสำหรับการนำความสามารถของ DevOps ไปใช้อย่างประสบความสำเร็จ Technical Documentation นี้ครอบคลุมหัวข้อที่หลากหลาย ได้แก่:
- Architectural Diagrams, Business Logic Descriptions, …
- ขั้นตอนเกี่ยวกับวิธีการ Setup ค่า สำหรับ Project ใหม่บน Laptop ของคุณ
- Coding Standards และ Best Software Development Practices
แม้ว่าจะมี Knowledge Management Tools อยู่มากมาย แต่ส่วนใหญ่เป็น Tools ทั่วไปเนื่องจาก Audiences จะกล่าวถึงทุกแผนกในองค์กร ไม่ว่าจะเป็น HR, Marketing, Sales, Tech,...
การ Integrate การใช้งานร่วมกับ Tools ที่มักใช้กันประจำวันอย่างเช่น IDE เป็นการช่วยทำให้เพิ่มมูลค่าที่แท้จริงสำหรับ Software Developers และในบทความนี้จะครอบคลุมถึง VS Code Extensions บางตัวที่ช่วยให้ Developers สร้างและ Maintain Technical Documentation ร่วมกับสมาชิกในทีม เรามาดูกันเลยว่ามี Extensions อะไรบ้าง
1. Swimm
ประโยชน์ของ Swimm คือจะช่วยให้ Developers สามารถปรับปรุง Technical Documentation ของพวกเขาให้ Update อยู่เสมอ มันมี Web Platform สำหรับเขียน Technical Documentation ได้อย่างง่ายดาย และ "Snippet Studio" Feature เพื่อช่วยให้กระบวนการนั้นง่ายขึ้น มันเป็นเหมือนแค่แนวคิดที่คลุมเครือ แต่มันก็มีขึ้นเพื่อรองรับ Tech Environment
คุณสามารถใช้ Swimm เพื่อ Integrate กับ Git Repositories ของคุณ เพื่อให้แต่ละ Snippet Code ที่ถูกบันทึกไว้ใน Documentation ของคุณได้รับการ Synchronize อย่างสม่ำเสมอในระหว่าง CI/CD Process ของคุณ และคุณจะได้รับการเตือนให้รู้ในกรณีที่ Code ของคุณมีการเปลี่ยนแปลง หากเป็นกรณีนี้ คุณจะสามารถ Synchronize การเปลี่ยนแปลงใน Documentation ของคุณได้โดยอัตโนมัติ คุณอาจต้องนึกอยู่เสมอว่า Documentation ของคุณมี Code Snippets ที่สามารถเปลี่ยนแปลงได้อยู่ตลอดเวลา
จากนั้น IDE Extension จะแจ้งให้คุณทราบเมื่อพวกมันกำลังทำงานกับ Snippets ที่มี Documentation อยู่ใน Swimm เพื่อให้คุณสามารถเปิด Documentation ในรูปแบบ Markdown จนถึงตอนนี้ นี่เป็นเพียง Read-Only Process
2. CodeTour
CodeTour เป็น VS Code Extension เพื่อ Record และ Play Guide ทีละขั้นตอนสำหรับ Codebase ของคุณ คุณสามารถสร้าง Collection ของ Guided Tours ใน Code การ Tour แต่ละครั้งเป็นเพียง Set ของแต่ละ Steps และ Step ก็คือ ตำแหน่งใน Source Code พร้อม Description แบบข้อความ จุดประสงค์หลักของการ Tours ก็คือเพื่ออำนวยความสะดวกในการเริ่ม Project ใหม่ของ Developers เมื่อคุณเริ่ม Tour ระบบจะนำคุณไปยังแต่ละ Code Snippets ที่เกี่ยวข้องพร้อมกับ Comment
คุณยังสามารถเชื่อมโยงระหว่างแต่ละ Tours เพื่อให้ง่ายต่อการ Navigate Codebase ได้อีกด้วย อีกทั้งคุณยังสามารถกำหนด Tours ตัวหลัก ซึ่งจะถูกเปิดขึ้นในครั้งแรกที่ Developers ทำการเปิด Codebase เนื่องจากคุณสามารถ Export Tour เป็น Files ดังนั้นการกำหนด Version ใน Git Repositories จึงเป็นเรื่องง่าย นอกจากนี้ ทั้ง 2 สิ่งข้างต้นยังรองรับสำหรับ GitHub Actions และ Azure Pipelines ที่ประเมินว่า Tours นั้นเป็นข้อมูลที่ Update ตรงกับ State ปัจจุบันของ Codebase หรือไม่
3. SourceTape
ด้วย SourceTape คุณสามารถสร้าง Interactive Video Sessions พร้อมด้วยการบันทึก Audio จาก VS Code ของคุณได้โดยตรง คุณสามารถ Browse Files ต่าง ๆ ในระหว่าง Session ของคุณและเน้นไปที่บรรทัดของ Code ที่คุณต้องการที่จะกล่าวถึง
เมื่อการบันทึกใน IDE ของคุณสิ้นสุดลง คุณจะสามารถเข้าถึง Web UI เพื่ออ่าน Timeline ของ Video และเพิ่มเนื้อหาที่เป็นข้อความได้ ด้วยสิ่งนี้ จึงทำให้คุณสามารถสร้าง Collection ของ Sessions ร่วมกับทีมของคุณได้ ซึ่งจะพร้อมใช้งานได้โดยตรงภายใน IDE ของคุณ นอกจากนี้คุณยังสามารถจัด Video เป็นกลุ่ม ๆ และแชร์กับทีมของคุณได้อีกด้วย
4. Promyze
Promyze จะช่วยให้คุณกำหนด Best Practices และแบ่งปันกับทีมของคุณ คุณสามารถระบุ Examples และ Counter-Examples ของ Best Practices ใน Source Code ได้อย่างง่ายดาย ทุกคนมีอิสระที่จะมีส่วนร่วมและสามารถแนะนำ Practices บางอย่างได้
ความพิเศษของ Promyze อีกอย่างก็คือ การมีส่วนร่วมแต่ละครั้งจะได้รับการ Review ผ่าน Collaborative Sessions ที่เรียกว่า Craft Workshops โดย Developers จะสร้าง Documentation และทำการ Validate พวกมันทั้งหมดหากพวกเขาเห็นด้วยกับตัวอย่าง Best Practices แต่ในบางกรณี พวกเขาอาจจะยังไม่ตัดสินใจใด ๆ หรือเริ่มการหาข้อดีและข้อเสียสำหรับ Best Practices ซึ่ง Process นี้จะช่วยให้ทีมและองค์กรสามารถปรับ Coding Practices ของพวกเขาได้, ใช้ประโยชน์จากความรู้ของ Developers ทุกคนในทีม และส่งเสริมการมี Interaction ทางด้านเทคนิคกันภายในทีม
ต้องขอบคุณ Plugin นี้ ที่ช่วยทำให้คุณสามารถ Browse Repository ปัจจุบันของ Best Practices และรับคำแนะนำโดยอัตโนมัติจาก Promyze ขึ้นอยู่กับตัวอย่างของ Practices Repository ในตัวอย่างด้านล่างนี้ เราจะแนะนำว่า Source Code นี้ไม่เป็นไปตาม Practice: “Promise.all should be used for parallel calls” นอกจากนี้เรายังสามารถเพิ่มการแก้ไขและส่งมันไปที่ Promyze เพื่อเน้นว่าควรนำ Practice นี้ไปใช้อย่างไร
ที่มา: https://medium.com/promyze/
รับตำแหน่งงานไอทีใหม่ๆ ด้วยบริการ IT Job Alert
|
|
อัพเดทบทความจากคนวงในสายไอทีทาง LINE ก่อนใคร
อย่าลืมแอดไลน์ @techstarth เป็นเพื่อนนะคะ
|
|
บทความล่าสุด