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
130

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
200
Welcome & Tech Vision Keynote
Avatar for LINE Developers Thailand linedevth
0
180
Building the Future: LINE API Updates in 2024
Avatar for LINE Developers Thailand linedevth
1
170
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
130
The Future of LINE Retail Chatbot using Gemini AI
Avatar for LINE Developers Thailand linedevth
0
300
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
98
B.A.A.S - BeTask AI and Automation for SMEs
Avatar for LINE Developers Thailand linedevth
0
88

Other Decks in Technology

See All in Technology
本当にわかりやすいAIエージェント入門
Avatar for segavvy segavvy
1
480
cdk initで生成されるあのファイル達は何なのか/cdk-init-generated-files
Avatar for tomoki10 tomoki10
1
670
ゼロから始めるSREの事業貢献 - 生成AI時代のSRE成長戦略と実践 / Starting SRE from Day One
Avatar for Shinichi Nakagawa shinyorke
PRO
0
120
名刺メーカーDevグループ 紹介資料
Avatar for Sansan, Inc. sansan33
PRO
0
820
モニタリング統一への道のり - 分散モニタリングツール統合のためのオブザーバビリティプロジェクト
Avatar for ニフティ株式会社 niftycorp
PRO
1
520
公開初日に Gemini CLI を試した話や FFmpeg と組み合わせてみた話など / Gemini CLI 初学者勉強会（#AI道場）
Avatar for you（@youtoy） you
PRO
0
1.3k
Introduction to Sansan for Engineers / エンジニア向け会社紹介
Avatar for Sansan, Inc. sansan33
PRO
5
39k
AWS CDK 入門ガイド これだけは知っておきたいヒント集
Avatar for Anan Kikuchi anank
5
760
クラウド開発の舞台裏とSRE文化の醸成 / SRE NEXT 2025 Lunch Session
Avatar for kazeburo kazeburo
1
590
[SRE NEXT] ARR150億円_エンジニア140名_27チーム_17プロダクトから始めるSLO.pdf
Avatar for sato-s satos
5
3k
Data Engineering Study#30 LT資料
Avatar for tetsuroito tetsuroito
1
200
“日本一のM&A企業”を支える、少人数SREの効率化戦略 / SRE NEXT 2025
Avatar for GENDA genda
1
270

Featured

See All Featured
Building a Modern Day 
E-commerce SEO Strategy
Avatar for Aleyda Solis aleyda
42
7.4k
Sharpening the Axe: The Primacy of Toolmaking
Avatar for Bryan Cantrill bcantrill
44
2.4k
"I'm Feeling Lucky" - Building Great Search Experiences for Today's Users (#IAC19)
Avatar for Dan Newman danielanewman
229
22k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
Avatar for Joe Casabona jcasabona
32
2.4k
Fantastic passwords and where to find them - at NoRuKo
Avatar for Phil Nash philnash
51
3.3k
Producing Creativity
Avatar for Steve Smith orderedlist
PRO
346
40k
How to train your dragon (web standard)
Avatar for Monica Dinculescu notwaldorf
96
6.1k
Site-Speed That Sticks
Avatar for Harry Roberts csswizardry
10
700
Code Review Best Practice
Avatar for Trisha Gee trishagee
69
19k
Six Lessons from altMBA
Avatar for Skipper Chong Warson skipperchong
28
3.9k
Keith and Marios Guide to Fast Websites
Avatar for Keith Pitt keithpitt
411
22k
The Straight Up "How To Draw Better" Workshop
Avatar for Dennis Kardys denniskardys
235
140k

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