Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Boosting Development Quality through Continuous...

Avatar for LINE Developers Thailand LINE Developers Thailand
October 29, 2024
Technology
0
140

Boosting Development Quality through Continuous Documentation Integration

Boosting Development Quality through Continuous Documentation Integration

Avatar for LINE Developers Thailand

LINE Developers Thailand

October 29, 2024
Tweet

More Decks by LINE Developers Thailand

See All by LINE Developers Thailand
LINE API Deep Dive Q1 2025: Unlocking New Possibilities
Avatar for LINE Developers Thailand linedevth
1
210
Welcome & Tech Vision Keynote
Avatar for LINE Developers Thailand linedevth
0
190
Building the Future: LINE API Updates in 2024
Avatar for LINE Developers Thailand linedevth
1
190
Revolutionizing Telepharmacy with The POWER of Gen AI and LINE API
Avatar for LINE Developers Thailand linedevth
0
200
Seamless Inventory Management with ChatGPT and LINE SHOPPING API
Avatar for LINE Developers Thailand linedevth
0
130
The Future of LINE Retail Chatbot using Gemini AI
Avatar for LINE Developers Thailand linedevth
0
310
Domain Data Platform for Scalable Data Management
Avatar for LINE Developers Thailand linedevth
0
120
Building a Fortune Teller App with OpenAI From Chatbot to Voice Assistant
Avatar for LINE Developers Thailand linedevth
0
110
B.A.A.S - BeTask AI and Automation for SMEs
Avatar for LINE Developers Thailand linedevth
0
96

Other Decks in Technology

See All in Technology
Preferred Networks (PFN) とLLM Post-Training チームの紹介 / 第4回 関東Kaggler会 スポンサーセッション
Avatar for Preferred Networks pfn
PRO
1
240
Android Studio の 新しいAI機能を試してみよう / Try out the new AI features in Android Studio
Avatar for Yuki Anzai yanzm
0
270
生成AI利用プログラミング：誰でもプログラムが書けると 世の中どうなる？/opencampus202508
Avatar for Oka Natsuki okana2ki
0
190
会社にデータエンジニアがいることでできるようになること
Avatar for 10xinc 10xinc
9
1.6k
Backboneとしてのtimm2025
Avatar for yu4u yu4u
4
1.6k
モバイルアプリ研修
Avatar for Recruit recruitengineers
PRO
3
330
Yahoo!広告ビジネス基盤におけるバックエンド開発
Avatar for LINEヤフーTech (LY Corporation Tech) lycorptech_jp
PRO
1
280
Webアクセシビリティ入門
Avatar for Recruit recruitengineers
PRO
1
320
現場が抱える様々な問題は “組織設計上” の問題によって生じていることがある / Team-oriented Organization Design 20250827
Avatar for mtx2s mtx2s
5
1.3k
ソフトウェア エンジニアとしての 姿勢と心構え
Avatar for Recruit recruitengineers
PRO
4
1.1k
Understanding Go GC #coefl_go_jp
Avatar for 弁護士ドットコム bengo4com
0
1.1k
LLM時代の検索とコンテキストエンジニアリング
Avatar for shibuiwilliam shibuiwilliam
2
1.1k

Featured

See All Featured
Writing Fast Ruby
Avatar for Erik Berlin sferik
628
62k
Scaling GitHub
Avatar for Zach Holman holman
462
140k
Being A Developer After 40
Avatar for Adrian Kosmaczewski akosma
90
590k
Agile that works and the tools we love
Avatar for Rasmus Luckow-Nielsen rasmusluckow
329
21k
The Art of Delivering Value - GDevCon NA Keynote
Avatar for David Neal reverentgeek
15
1.6k
The Success of Rails: Ensuring Growth for the Next 100 Years
Avatar for Eileen M. Uchitelle eileencodes
46
7.6k
Statistics for Hackers
Avatar for Jake VanderPlas jakevdp
799
220k
The MySQL Ecosystem @ GitHub 2015
Avatar for Sam Lambert samlambert
251
13k
The Art of Programming - Codeland 2020
Avatar for Erika Heidi erikaheidi
55
13k
Responsive Adventures: Dirty Tricks From The Dark Corners of Front-End
Avatar for Vitaly Friedman smashingmag
251
21k
GraphQLとの向き合い方2022年版
Avatar for Yosuke Kurami quramy
49
14k
Reflections from 52 weeks, 52 projects
Avatar for Jefferson Lam jeffersonlam
351
21k

Transcript

  1. Boosting Development Quality through Continuous Documentation Integration

  2. Have you seen anything like this?

  3. Have you seen anything like this?

  4. • How can we improve document? • How can we

    use it to improve development quality? Agenda

  5. Swagger generator Swaggo

  6. Swagger generator

  7. Swagger generator

  8. Swagger generator

  9. Swaggo Code Swagger YAML

  10. Swaggo Swagger YAML DEV DEV

  11. QA Other Dev team DEV DEV Swagger YAML

  12. Swaggo Swagger YAML QA Other Dev team DEV DEV Swaggo

    Swagger YAML Swaggo Swagger YAML

  13. Swagger YAML Swagger YAML Swagger YAML Document Portal QA Other

    Dev team DEV DEV

  14. Docusaurus

  15. What is Docusaurus?

  16. What is Docusaurus? • Static website generator • Markdown based

    • React component support, we can do many things with this!

  17. Docusaurus + Redocly

  18. Redocly

  19. Integrate with CI/CD DEV push code Swagger YAML Git

  20. Integrate with CI/CD DEV push code deploy application pipeline Git

    Kubernetes Swagger YAML

  21. Integrate with CI/CD DEV push code deploy application pipeline document

    pipeline build grab swagger files Git Kubernetes Swagger YAML

  22. Integrate with CI/CD document pipeline build application pipeline application pipeline

    application pipeline when dev env deployed

  23. Docusaurus + Redocly

  24. Database spec

  25. Database spec

  26. Kafka spec

  27. Not only Redocly! Mermaid

  28. Mermaid

  29. Mermaid

  30. Mermaid

  31. Not only Redocly! draw.io

  32. draw.io

  33. Can see changes in PR

  34. Can see changes in PR

  35. DEV DEV DEV API Changes

  36. DEV Pull Request DEV DEV Revie w swagger changes API

    Changes Pull Request kafka spec changes

  37. DEV Pull Request DEV DEV Revie w swagger changes Pull

    Request kafka spec changes Pull Request logic implementation API Changes

  38. Even more use case

  39. Key Takeaways • Use code as document as much as

    possible • Make document changes easy to review • Communicate with the team using document
  40. None