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
Amazon Route 53, 待ちに待った TLSAレコードのサポート開始
kenichinakamura
0
170
データ基盤におけるIaCの重要性とその運用
mtpooh
4
530
Git scrapingで始める継続的なデータ追跡 / Git Scraping
ohbarye
5
500
My small contributions - Fujiwara Tech Conference 2025
ijin
0
1.4k
ドメイン駆動設計の実践により事業の成長スピードと保守性を両立するショッピングクーポン
lycorptech_jp
PRO
12
2.2k
Unsafe.BitCast のすゝめ。
nenonaninu
0
200
AWSマルチアカウント統制環境のすゝめ / 20250115 Mitsutoshi Matsuo
shift_evolve
0
120
RubyでKubernetesプログラミング
sat
PRO
4
160
完全自律型AIエージェントとAgentic Workflow〜ワークフロー構築という現実解
pharma_x_tech
0
350
FODにおけるホーム画面編成のレコメンド
watarukudo
PRO
2
280
iPadOS18でフローティングタブバーを解除してみた
sansantech
PRO
1
140
[IBM TechXchange Dojo]Watson Discoveryとwatsonx.aiでRAGを実現!座学①
siyuanzh09
0
110
Featured
See All Featured
The Language of Interfaces
destraynor
155
24k
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
33
2.7k
Visualizing Your Data: Incorporating Mongo into Loggly Infrastructure
mongodb
44
9.4k
Agile that works and the tools we love
rasmusluckow
328
21k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
507
140k
VelocityConf: Rendering Performance Case Studies
addyosmani
327
24k
Side Projects
sachag
452
42k
How to train your dragon (web standard)
notwaldorf
89
5.8k
Building Applications with DynamoDB
mza
93
6.2k
Gamification - CAS2011
davidbonilla
80
5.1k
The Psychology of Web Performance [Beyond Tellerrand 2023]
tammyeverts
45
2.3k
Cheating the UX When There Is Nothing More to Optimize - PixelPioneers
stephaniewalter
280
13k
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