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
110

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
190
Welcome & Tech Vision Keynote
Avatar for LINE Developers Thailand linedevth
0
170
Building the Future: LINE API Updates in 2024
Avatar for LINE Developers Thailand linedevth
1
160
Revolutionizing Telepharmacy with The POWER of Gen AI and LINE API
Avatar for LINE Developers Thailand linedevth
0
180
Seamless Inventory Management with ChatGPT and LINE SHOPPING API
Avatar for LINE Developers Thailand linedevth
0
110
The Future of LINE Retail Chatbot using Gemini AI
Avatar for LINE Developers Thailand linedevth
0
260
Domain Data Platform for Scalable Data Management
Avatar for LINE Developers Thailand linedevth
0
100
Building a Fortune Teller App with OpenAI From Chatbot to Voice Assistant
Avatar for LINE Developers Thailand linedevth
0
91
B.A.A.S - BeTask AI and Automation for SMEs
Avatar for LINE Developers Thailand linedevth
0
81

Other Decks in Technology

See All in Technology
CSS polyfill とその未来
Avatar for ken7253 ken7253
0
140
AIのための
オンボーディングドキュメントを整備する - hirotea
Avatar for hirotea hirotea
9
2.3k
Swiftは最高だよの話
Avatar for 野瀬田　裕樹 yuukiw00w
2
290
All About Sansan – for New Global Engineers
Avatar for Sansan, Inc. sansan33
PRO
1
1.2k
ゴリラ.vim #36 ~ Vim x SNS ~ スポンサーセッション
Avatar for yasunori yasunori0418
1
350
Eight Engineering Unit 紹介資料
Avatar for Sansan, Inc. sansan33
PRO
0
3.2k
Houtou.pm #1
Avatar for papix papix
0
660
Slackひと声でブログ校正！Claudeレビュー自動化編
Avatar for Yusuke Shimizu yusukeshimizu
3
180
研究開発部メンバーの働き⽅ / Sansan R&D Profile
Avatar for Sansan, Inc. sansan33
PRO
3
17k
TechBull Membersの開発進捗どうですか！？
Avatar for adachin0817 rvirus0817
0
190
Javaアプリケーションの配布とパッケージング / Distribution and packaging of Java applications
Avatar for hogelog hogelog
1
140
会社紹介資料 / Sansan Company Profile
Avatar for Sansan, Inc. sansan33
PRO
6
360k

Featured

See All Featured
Fashionably flexible responsive web design (full day workshop)
Avatar for Andy Clarke malarkey
407
66k
Automating Front-end Workflow
Avatar for Addy Osmani addyosmani
1370
200k
Intergalactic Javascript Robots from Outer Space
Avatar for Vicent Martí tanoku
271
27k
The World Runs on Bad Software
Avatar for Brandon Keepers bkeepers
PRO
68
11k
Into the Great Unknown - MozCon
Avatar for Noah Learner thekraken
39
1.8k
Facilitating Awesome Meetings
Avatar for Lara Hogan lara
54
6.4k
Designing for humans not robots
Avatar for Tammie Lister tammielis
253
25k
RailsConf & Balkan Ruby 2019: The Past, Present, and Future of Rails at GitHub
Avatar for Eileen M. Uchitelle eileencodes
137
34k
Practical Tips for Bootstrapping Information Extraction Pipelines
Avatar for Matthew Honnibal honnibal
PRO
19
1.2k
CSS Pre-Processors: Stylus, Less & Sass
Avatar for Bermon Painter bermonpainter
357
30k
The Invisible Side of Design
Avatar for Vitaly Friedman smashingmag
299
50k
Code Review Best Practice
Avatar for Trisha Gee trishagee
68
18k

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