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
140
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
LINE API Deep Dive Q1 2025: Unlocking New Possibilities
linedevth
1
220
Welcome & Tech Vision Keynote
linedevth
0
200
Building the Future: LINE API Updates in 2024
linedevth
1
190
Revolutionizing Telepharmacy with The POWER of Gen AI and LINE API
linedevth
0
200
Seamless Inventory Management with ChatGPT and LINE SHOPPING API
linedevth
0
130
The Future of LINE Retail Chatbot using Gemini AI
linedevth
0
320
Domain Data Platform for Scalable Data Management
linedevth
0
130
Building a Fortune Teller App with OpenAI From Chatbot to Voice Assistant
linedevth
0
120
B.A.A.S - BeTask AI and Automation for SMEs
linedevth
0
100
Other Decks in Technology
See All in Technology
進捗
ydah
2
230
Language Update: Java
skrb
2
260
DevIO2025_継続的なサービス開発のための技術的意思決定のポイント / how-to-tech-decision-makaing-devio2025
nologyance
0
180
【初心者向け】ローカルLLMの色々な動かし方まとめ
aratako
7
3.2k
「魔法少女まどか☆マギカ Magia Exedra」の必殺技演出を徹底解剖! -キャラクターの魅力を最大限にファンに届けるためのこだわり-
gree_tech
PRO
0
550
ヘブンバーンズレッドにおける、世界観を活かしたミニゲーム企画の作り方
gree_tech
PRO
0
540
シークレット管理だけじゃない!HashiCorp Vault でデータ暗号化をしよう / Beyond Secret Management! Let's Encrypt Data with HashiCorp Vault
nnstt1
3
220
下手な強制、ダメ!絶対! 「ガードレール」を「檻」にさせない"ガバナンス"の取り方とは?
tsukaman
1
280
AI時代に非連続な成長を実現するエンジニアリング戦略
sansantech
PRO
3
1.1k
【Grafana Meetup Japan #6】Grafanaをリバプロ配下で動かすときにやること ~ Grafana Liveってなんだ ~
yoshitake945
0
230
Bye-Bye Query Spaghetti: Write Queries You'll Actually Understand Using Pipelined SQL Syntax
tobiaslampertlotum
0
140
今!ソフトウェアエンジニアがハードウェアに手を出すには
mackee
9
4.2k
Featured
See All Featured
Docker and Python
trallard
45
3.5k
Git: the NoSQL Database
bkeepers
PRO
431
66k
We Have a Design System, Now What?
morganepeng
53
7.8k
The Cost Of JavaScript in 2023
addyosmani
53
8.9k
Music & Morning Musume
bryan
46
6.8k
jQuery: Nuts, Bolts and Bling
dougneiner
64
7.9k
Fight the Zombie Pattern Library - RWD Summit 2016
marcelosomers
234
17k
The Pragmatic Product Professional
lauravandoore
36
6.8k
Improving Core Web Vitals using Speculation Rules API
sergeychernyshev
18
1.1k
BBQ
matthewcrist
89
9.8k
Statistics for Hackers
jakevdp
799
220k
Designing Experiences People Love
moore
142
24k
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