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
90
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
140
Building the Future: LINE API Updates in 2024
linedevth
0
130
Revolutionizing Telepharmacy with The POWER of Gen AI and LINE API
linedevth
0
150
Seamless Inventory Management with ChatGPT and LINE SHOPPING API
linedevth
0
99
The Future of LINE Retail Chatbot using Gemini AI
linedevth
0
220
Domain Data Platform for Scalable Data Management
linedevth
0
76
Building a Fortune Teller App with OpenAI From Chatbot to Voice Assistant
linedevth
0
70
B.A.A.S - BeTask AI and Automation for SMEs
linedevth
0
65
Safeguarding GenAI Chatbot with AI Guardrails
linedevth
0
94
Other Decks in Technology
See All in Technology
Classmethod AI Talks(CATs) #17 司会進行スライド(2025.02.19) / classmethod-ai-talks-aka-cats_moderator-slides_vol17_2025-02-19
shinyaa31
0
120
Developers Summit 2025 浅野卓也(13-B-7 LegalOn Technologies)
legalontechnologies
PRO
0
730
白金鉱業Meetup Vol.17_あるデータサイエンティストのデータマネジメントとの向き合い方
brainpadpr
6
760
関東Kaggler会LT: 人狼コンペとLLM量子化について
nejumi
3
600
技術的負債解消の取り組みと専門チームのお話 #技術的負債_Findy
bengo4com
1
1.3k
CZII - CryoET Object Identification 参加振り返り・解法共有
tattaka
0
380
クラウドサービス事業者におけるOSS
tagomoris
2
840
一度 Expo の採用を断念したけど、 再度 Expo の導入を検討している話
ichiki1023
1
170
Classmethod AI Talks(CATs) #16 司会進行スライド(2025.02.12) / classmethod-ai-talks-aka-cats_moderator-slides_vol16_2025-02-12
shinyaa31
0
110
データの品質が低いと何が困るのか
kzykmyzw
6
1.1k
飲食店予約台帳を支えるインタラクティブ UI 設計と実装
siropaca
7
1.8k
データマネジメントのトレードオフに立ち向かう
ikkimiyazaki
6
990
Featured
See All Featured
jQuery: Nuts, Bolts and Bling
dougneiner
63
7.6k
The Power of CSS Pseudo Elements
geoffreycrofte
75
5.5k
Become a Pro
speakerdeck
PRO
26
5.1k
Product Roadmaps are Hard
iamctodd
PRO
50
11k
Rails Girls Zürich Keynote
gr2m
94
13k
StorybookのUI Testing Handbookを読んだ
zakiyama
28
5.5k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
33
2.1k
Making Projects Easy
brettharned
116
6k
RailsConf 2023
tenderlove
29
1k
Bash Introduction
62gerente
611
210k
Speed Design
sergeychernyshev
27
790
Easily Structure & Communicate Ideas using Wireframe
afnizarnur
193
16k
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