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
85
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
130
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
68
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
When Windows Meets Kubernetes…
pichuang
0
320
新卒1年目、はじめてのアプリケーションサーバー【IBM WebSphere Liberty】
ktgrryt
0
160
いま現場PMのあなたが、 経営と向き合うPMになるために 必要なこと、腹をくくること
hiro93n
9
8.2k
生成AIのビジネス活用
seosoft
0
110
Visual StudioとかIDE関連小ネタ話
kosmosebi
1
380
タイミーのデータ活用を支えるdbt Cloud導入とこれから
ttccddtoki
1
350
月間60万ユーザーを抱える 個人開発サービス「Walica」の 技術スタック変遷
miyachin
2
620
カップ麺の待ち時間(3分)でわかるPartyRockアップデート
ryutakondo
0
160
色々なAWSサービス名の由来を調べてみた
iriikeita
0
120
「人物ごとのアルバム」の精度改善の軌跡/Improving accuracy of albums by person
mixi_engineers
PRO
1
140
2025年の挑戦 コーポレートエンジニアの技術広報/techpr5
nishiuma
0
150
My small contributions - Fujiwara Tech Conference 2025
ijin
0
1.5k
Featured
See All Featured
How To Stay Up To Date on Web Technology
chriscoyier
790
250k
Faster Mobile Websites
deanohume
305
30k
Scaling GitHub
holman
459
140k
Building an army of robots
kneath
302
45k
[RailsConf 2023] Rails as a piece of cake
palkan
53
5.1k
Speed Design
sergeychernyshev
25
740
StorybookのUI Testing Handbookを読んだ
zakiyama
28
5.4k
Optimising Largest Contentful Paint
csswizardry
33
3k
Building Flexible Design Systems
yeseniaperezcruz
328
38k
Product Roadmaps are Hard
iamctodd
PRO
50
11k
GraphQLの誤解/rethinking-graphql
sonatard
68
10k
Making Projects Easy
brettharned
116
6k
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