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
26
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
57
Building the Future: LINE API Updates in 2024
linedevth
0
32
Revolutionizing Telepharmacy with The POWER of Gen AI and LINE API
linedevth
0
40
Seamless Inventory Management with ChatGPT and LINE SHOPPING API
linedevth
0
25
The Future of LINE Retail Chatbot using Gemini AI
linedevth
0
45
Domain Data Platform for Scalable Data Management
linedevth
0
29
Building a Fortune Teller App with OpenAI From Chatbot to Voice Assistant
linedevth
0
18
B.A.A.S - BeTask AI and Automation for SMEs
linedevth
0
20
Safeguarding GenAI Chatbot with AI Guardrails
linedevth
0
26
Other Decks in Technology
See All in Technology
ガバメントクラウド先行事業中間報告を読み解く
sugiim
1
1.9k
Fargateを使った研修の話
takesection
0
150
Forget efficiency – Become more productive without the stress
ufried
0
190
AWSコンテナ本出版から3年経った今、もし改めて執筆し直すなら / If I revise our container book
iselegant
18
4.2k
Spring Frameworkの新標準!? ~ RestClientとHTTPインターフェース入門 ~
ogiwarat
1
210
[AWS JAPAN 生成AIハッカソン] Dialog の紹介
yoshimi0227
0
170
フロントエンド メタフレームワーク 選定の際に考えたこと
yuppeeng
0
320
株式会社ログラス − エンジニア向け会社説明資料 / Loglass Comapany Deck for Engineer
loglass2019
3
28k
10分でわかるfreeeのQA
freee
1
3.4k
신뢰할 수 있는 AI 검색 엔진을 만들기 위한 Liner의 여정
huffon
0
450
コンテンツを支える 若手ゲームクリエイターの アートディレクションの事例紹介 / cagamefi-game
cyberagentdevelopers
PRO
1
140
ZOZOTOWNでの推薦システム活用事例の紹介
f6wbl6
0
230
Featured
See All Featured
Agile that works and the tools we love
rasmusluckow
327
21k
Building Your Own Lightsaber
phodgson
102
6.1k
ReactJS: Keep Simple. Everything can be a component!
pedronauck
664
120k
The Illustrated Children's Guide to Kubernetes
chrisshort
48
48k
Build The Right Thing And Hit Your Dates
maggiecrowley
32
2.4k
Happy Clients
brianwarren
97
6.7k
Typedesign – Prime Four
hannesfritz
39
2.4k
Speed Design
sergeychernyshev
24
580
Scaling GitHub
holman
458
140k
Gamification - CAS2011
davidbonilla
80
5k
CoffeeScript is Beautiful & I Never Want to Write Plain JavaScript Again
sstephenson
159
15k
The Straight Up "How To Draw Better" Workshop
denniskardys
232
140k
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