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
74
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
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
71
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
小学3年生夏休みの自由研究「夏休みに Copilot で遊んでみた」
taichinakamura
0
160
20241220_S3 tablesの使い方を検証してみた
handy
4
590
GitHub Copilot のテクニック集/GitHub Copilot Techniques
rayuron
36
14k
AWS re:Invent 2024で発表された コードを書く開発者向け機能について
maruto
0
190
Opcodeを読んでいたら何故かphp-srcを読んでいた話
murashotaro
0
260
ゼロから創る横断SREチーム 挑戦と進化の軌跡
rvirus0817
2
270
PHPerのための計算量入門/Complexity101 for PHPer
hanhan1978
5
140
WACATE2024冬セッション資料(ユーザビリティ)
scarletplover
0
210
Google Cloud で始める Cloud Run 〜AWSとの比較と実例デモで解説〜
risatube
PRO
0
110
ガバメントクラウドのセキュリティ対策事例について
fujisawaryohei
0
550
re:Invent 2024 Innovation Talks(NET201)で語られた大切なこと
shotashiratori
0
310
DUSt3R, MASt3R, MASt3R-SfM にみる3D基盤モデル
spatial_ai_network
2
160
Featured
See All Featured
How To Stay Up To Date on Web Technology
chriscoyier
789
250k
GraphQLの誤解/rethinking-graphql
sonatard
67
10k
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
38
1.9k
Side Projects
sachag
452
42k
Making the Leap to Tech Lead
cromwellryan
133
9k
Adopting Sorbet at Scale
ufuk
73
9.1k
GitHub's CSS Performance
jonrohan
1030
460k
The Illustrated Children's Guide to Kubernetes
chrisshort
48
48k
Done Done
chrislema
181
16k
How to Create Impact in a Changing Tech Landscape [PerfNow 2023]
tammyeverts
48
2.2k
Optimizing for Happiness
mojombo
376
70k
Practical Orchestrator
shlominoach
186
10k
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