Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Boosting Development Quality through Continuous...
Search
LINE Developers Thailand
October 29, 2024
Technology
0
84
Boosting Development Quality through Continuous Documentation Integration
Boosting Development Quality through Continuous Documentation Integration
LINE Developers Thailand
October 29, 2024
Tweet
Share
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
120
Revolutionizing Telepharmacy with The POWER of Gen AI and LINE API
linedevth
0
140
Seamless Inventory Management with ChatGPT and LINE SHOPPING API
linedevth
0
89
The Future of LINE Retail Chatbot using Gemini AI
linedevth
0
200
Domain Data Platform for Scalable Data Management
linedevth
0
67
Building a Fortune Teller App with OpenAI From Chatbot to Voice Assistant
linedevth
0
63
B.A.A.S - BeTask AI and Automation for SMEs
linedevth
0
61
Safeguarding GenAI Chatbot with AI Guardrails
linedevth
0
80
Other Decks in Technology
See All in Technology
シフトライトなテスト活動を適切に行うことで、無理な開発をせず、過剰にテストせず、顧客をビックリさせないプロダクトを作り上げているお話 #RSGT2025 / Shift Right
nihonbuson
3
2.1k
GoogleのAIエージェント論 Authors: Julia Wiesinger, Patrick Marlow and Vladimir Vuskovic
customercloud
PRO
0
130
データ基盤におけるIaCの重要性とその運用
mtpooh
4
440
.NET AspireでAzure Functionsやクラウドリソースを統合する
tsubakimoto_s
0
180
Godot Engineについて調べてみた
unsoluble_sugar
0
370
テストを書かないためのテスト/ Tests for not writing tests
sinsoku
1
170
あなたの知らないクラフトビールの世界
miura55
0
120
The future we create with our own MVV
matsukurou
0
2k
ABWGのRe:Cap!
hm5ug
1
120
Unsafe.BitCast のすゝめ。
nenonaninu
0
190
Kotlin Multiplatformのポテンシャル
recruitengineers
PRO
2
150
Copilotの力を実感!3ヶ月間の生成AI研修の試行錯誤&成功事例をご紹介。果たして得たものとは・・?
ktc_shiori
0
340
Featured
See All Featured
Writing Fast Ruby
sferik
628
61k
Music & Morning Musume
bryan
46
6.3k
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
33
2.7k
CSS Pre-Processors: Stylus, Less & Sass
bermonpainter
356
29k
How to Think Like a Performance Engineer
csswizardry
22
1.3k
Exploring the Power of Turbo Streams & Action Cable | RailsConf2023
kevinliebholz
28
4.5k
A Tale of Four Properties
chriscoyier
157
23k
YesSQL, Process and Tooling at Scale
rocio
170
14k
What’s in a name? Adding method to the madness
productmarketing
PRO
22
3.2k
VelocityConf: Rendering Performance Case Studies
addyosmani
327
24k
Fight the Zombie Pattern Library - RWD Summit 2016
marcelosomers
232
17k
Intergalactic Javascript Robots from Outer Space
tanoku
270
27k
Transcript
Boosting Development Quality through Continuous Documentation Integration
Have you seen anything like this?
Have you seen anything like this?
• How can we improve document? • How can we
use it to improve development quality? Agenda
Swagger generator Swaggo
Swagger generator
Swagger generator
Swagger generator
Swaggo Code Swagger YAML
Swaggo Swagger YAML DEV DEV
QA Other Dev team DEV DEV Swagger YAML
Swaggo Swagger YAML QA Other Dev team DEV DEV Swaggo
Swagger YAML Swaggo Swagger YAML
Swagger YAML Swagger YAML Swagger YAML Document Portal QA Other
Dev team DEV DEV
Docusaurus
What is Docusaurus?
What is Docusaurus? • Static website generator • Markdown based
• React component support, we can do many things with this!
Docusaurus + Redocly
Redocly
Integrate with CI/CD DEV push code Swagger YAML Git
Integrate with CI/CD DEV push code deploy application pipeline Git
Kubernetes Swagger YAML
Integrate with CI/CD DEV push code deploy application pipeline document
pipeline build grab swagger files Git Kubernetes Swagger YAML
Integrate with CI/CD document pipeline build application pipeline application pipeline
application pipeline when dev env deployed
Docusaurus + Redocly
Database spec
Database spec
Kafka spec
Not only Redocly! Mermaid
Mermaid
Mermaid
Mermaid
Not only Redocly! draw.io
draw.io
Can see changes in PR
Can see changes in PR
DEV DEV DEV API Changes
DEV Pull Request DEV DEV Revie w swagger changes API
Changes Pull Request kafka spec changes
DEV Pull Request DEV DEV Revie w swagger changes Pull
Request kafka spec changes Pull Request logic implementation API Changes
Even more use case
Key Takeaways • Use code as document as much as
possible • Make document changes easy to review • Communicate with the team using document
None