documentation Archive

ทำความรู้จักกับ Backstage สำหรับทำ software catalog

จากการแบ่งปันเรื่อง Microservices design ที่ Skooldio มาบ้างคำถามที่น่าสนใจคือ ในทีม หรือ บริษัทนั้น มี software อะไรบ้างหรือถามลงไปในรายละเอียดเช่น ส่วนอื่น ๆ ก็เช่นกันทั้งระบบงานต่าง ๆ library ที่มี และ data pipeline ต่างๆ มีรวมไว้ตรงกลาง เพื่อให้เข้าถึง หรือ ใช้งานง่าย ๆไม่ต้องไปถามคนโน้นที คนนั้นที !!อยากให้เป็น centralize system ได้ไหมหนึ่งในเครื่องมือที่ใช้ในการจัดการสิ่งเหล่านี้ก็คือ Backstage นั่นเอง

Read More…

ว่าด้วยเรื่องของ EventCatalog

ในโลกของ Event-Driven Architecture นั้นมักจะมีการออกแบบ event ต่าง ๆสำหรับติดต่อสื่อสารระหว่างส่วนการทำงานแต่สิ่งหนึ่งที่มักจะขาดหายไปคือ เอกสารของแต่ละ event ว่ามีรายละเอียดอย่างไรแต่ละ event ข้าม service หรือ domain อะไรบ้างดังนั้นถ้ามีเครื่องมือมาช่วยจัดการน่าจะดีขึ้นหนึ่งในเครื่องมือที่น่าสนใจคือ EventCatalog

Read More…

ไปอ่านกัน React Docs ตัวใหม่ (Beta อยู่นะ)

สำหรับนักพัฒนาฝั่ง Frontend สาย Reactเป็นเรื่องที่น่ายินดีมาก ๆ ที่มีการสร้าง document ขึ้นมาใหม่เนื่องจากของเดิมเข้าใจยากพอควรสำหรับคนเริ่มต้นซึ่งมีทั้ง class component รวมกับ function component และ Hooksจัดได้ว่ามั่วก็ว่าได้ ยิ่งคนเริ่มต้นยิ่งหนักหนา !!

Read More…

สรุปจากบทความเรื่อง Best practices for writing code comments

อ่านบทความเรื่อง Best practices for writing code comments จาก StackOverflowทำการสรุปและคำแนะนำเกี่ยวกับการเขียน comment ใน code ที่ดีเพื่อช่วยให้คุณภาพของ code ดีขึ้น มีประโยคที่น่าสนใจคือการเขียน comment ที่แย่ ๆ มันแย่กว่าการไม่เขียนอีกนะดังนั้นเราไม่ควรเขียน comment ใช่หรือไม่ ?เพราะว่า แม้จะเขียนไม่ดี compiler ก็ไม่ได้ตรวจสอบให้ถ้า comment ไม่ตรงกับการทำงานจริง ก็ไม่มีอะไรเกิดขึ้นดังนั้นการเขียนมันใช้ทั้งเวลาและความพยายาม !!

Read More…

สวยดีนะ กับ Diagram as a Code (DaaC)

มาลองสร้าง Diagram หรือแผนภาพแสดงโครงสร้างของระบบต่าง ๆ ไม่ว่าระบบทำการ implement บน AWS, Azure, GCP และ Kubernetes นั้น สามารถสร้างง่าย ๆ ด้วยการเขียน code ภาษา Python โดยใช้งาน library ชื่อว่า  Diagrams มาลองใช้งานกัน

Read More…

มาลองเขียน Flow chart และ Sequence diagram ด้วย MermaidJS กัน

พอดีต้องเขียนเอกสารอธิบายขั้นตอนการทำงานของระบบงานนิดหน่อย ถ้าจะเขียนแบบใช้ program มาช่วย มันดูจะลำบากเกินไปหน่อย เลยคิดว่า ถ้าเขียนเป็นไฟล์ในรูปแบบ Markdown แล้วทำการแปลงมาอยู่ในรูปแบบต่าง ๆ ได้เลยเช่นรูปและ pdf น่าจะสะดวกกว่า แถมสามารถเก็บไฟล์ Markdown ไว้ใน Version Control System ได้อีกด้วย จึงลองไปหาดูว่ามีอะไรให้ใช้บ้าง

Read More…

ทำความรู้จักกับ Stack Overflow Documentation 

ทาง StackOverflow ได้เปิดระบบที่เรียกว่า Documentation เป็นอีกแหล่งความรู้สำหรับนักพัฒนา software โดยเฉพาะ โดยข้อมูลต่าง ๆ ของระบบมาจาก community นั่นเอง ซึ่งเน้นในเรื่องของตัวอย่าง ตัวอย่าง และ ตัวอย่าง code ดังนั้นพลาดไม่ได้ด้วยประการทั้งปวง มาทำความรู้จักกับ Stack Overflow Documentation กัน ซึ่งสรุปจากบทความเรื่อง Introducing Stack Overflow Documentation Beta

Read More…