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

Boosting Development Quality through Continuous...

LINE Developers Thailand
October 29, 2024
Technology
0
74

Boosting Development Quality through Continuous Documentation Integration

Boosting Development Quality through Continuous Documentation Integration

LINE Developers Thailand

October 29, 2024
Tweet

More Decks by LINE Developers Thailand

See All by LINE Developers Thailand
Welcome & Tech Vision Keynote
linedevth
0
120
Building the Future: LINE API Updates in 2024
linedevth
0
100
Revolutionizing Telepharmacy with The POWER of Gen AI and LINE API
linedevth
0
130
Seamless Inventory Management with ChatGPT and LINE SHOPPING API
linedevth
0
70
The Future of LINE Retail Chatbot using Gemini AI
linedevth
0
180
Domain Data Platform for Scalable Data Management
linedevth
0
61
Building a Fortune Teller App with OpenAI From Chatbot to Voice Assistant
linedevth
0
58
B.A.A.S - BeTask AI and Automation for SMEs
linedevth
0
55
Safeguarding GenAI Chatbot 
with AI Guardrails
linedevth
0
72

Other Decks in Technology

See All in Technology
OpenAIの蒸留機能(Model Distillation)を使用して運用中のLLMのコストを削減する取り組み
pharma_x_tech
4
540
OpenShift Virtualizationのネットワーク構成を真剣に考えてみた/OpenShift Virtualization's Network Configuration
tnk4on
0
130
宇宙ベンチャーにおける最近の情シス取り組みについて
axelmizu
0
110
日本版とグローバル版のモバイルアプリ統合の開発の裏側と今後の展望
miichan
1
120
ガバメントクラウドのセキュリティ対策事例について
fujisawaryohei
0
530
社外コミュニティで学び社内に活かす共に学ぶプロジェクトの実践/backlogworld2024
nishiuma
0
250
KubeCon NA 2024 Recap: How to Move from Ingress to Gateway API with Minimal Hassle
ysakotch
0
200
1等無人航空機操縦士一発試験 合格までの道のり ドローンミートアップ@大阪 2024/12/18
excdinc
0
150
バクラクのドキュメント解析技術と実データにおける課題 / layerx-ccc-winter-2024
shimacos
2
1k
KnowledgeBaseDocuments APIでベクトルインデックス管理を自動化する
iidaxs
1
250
マルチプロダクト開発の現場でAWS Security Hubを1年以上運用して得た教訓
muziyoshiz
2
2.1k
Oracle Cloud Infrastructure：2024年12月度サービス・アップデート
oracle4engineer
PRO
0
160

Featured

See All Featured
How to Think Like a Performance Engineer
csswizardry
22
1.2k
Exploring the Power of Turbo Streams & Action Cable | RailsConf2023
kevinliebholz
28
4.3k
The World Runs on Bad Software
bkeepers
PRO
65
11k
"I'm Feeling Lucky" - Building Great Search Experiences for Today's Users (#IAC19)
danielanewman
226
22k
GraphQLとの向き合い方2022年版
quramy
44
13k
Product Roadmaps are Hard
iamctodd
PRO
49
11k
Mobile First: as difficult as doing things right
swwweet
222
9k
How to Create Impact in a Changing Tech Landscape [PerfNow 2023]
tammyeverts
48
2.2k
Building Better People: How to give real-time feedback that sticks.
wjessup
365
19k
A Philosophy of Restraint
colly
203
16k
Building Flexible Design Systems
yeseniaperezcruz
327
38k
Understanding Cognitive Biases in Performance Measurement
bluesmoon
26
1.5k

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