Boosting Development Quality through Continuous Documentation Integration

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

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

Kafka spec

Not only Redocly! Mermaid

Mermaid

Not only Redocly! draw.io

draw.io

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

More Decks by LINE Developers Thailand