Boosting Development Quality through Continuous Documentation Integration

Slide 1

Slide 1 text

Slide 2

Slide 2 text

Have you seen anything like this?

Slide 3

Slide 3 text

Have you seen anything like this?

Slide 4

Slide 4 text

• How can we improve document? • How can we use it to improve development quality? Agenda

Slide 5

Slide 5 text

Swagger generator Swaggo

Slide 6

Slide 6 text

Swagger generator

Slide 7

Slide 7 text

Swagger generator

Slide 8

Slide 8 text

Swagger generator

Slide 9

Slide 9 text

Swaggo Code Swagger YAML

Slide 10

Slide 10 text

Swaggo Swagger YAML DEV DEV

Slide 11

Slide 11 text

QA Other Dev team DEV DEV Swagger YAML

Slide 12

Slide 12 text

Swaggo Swagger YAML QA Other Dev team DEV DEV Swaggo Swagger YAML Swaggo Swagger YAML

Slide 13

Slide 13 text

Swagger YAML Swagger YAML Swagger YAML Document Portal QA Other Dev team DEV DEV

Slide 14

Slide 14 text

Docusaurus

Slide 15

Slide 15 text

What is Docusaurus?

Slide 16

Slide 16 text

What is Docusaurus? • Static website generator • Markdown based • React component support, we can do many things with this!

Slide 17

Slide 17 text

Docusaurus + Redocly

Slide 18

Slide 18 text

Redocly

Slide 19

Slide 19 text

Integrate with CI/CD DEV push code Swagger YAML Git

Slide 20

Slide 20 text

Integrate with CI/CD DEV push code deploy application pipeline Git Kubernetes Swagger YAML

Slide 21

Slide 21 text

Integrate with CI/CD DEV push code deploy application pipeline document pipeline build grab swagger files Git Kubernetes Swagger YAML

Slide 22

Slide 22 text

Integrate with CI/CD document pipeline build application pipeline application pipeline application pipeline when dev env deployed

Slide 23

Slide 23 text

Docusaurus + Redocly

Slide 24

Slide 24 text

Database spec

Slide 25

Slide 25 text

Database spec

Slide 26

Slide 26 text

Kafka spec

Slide 27

Slide 27 text

Not only Redocly! Mermaid

Slide 28

Slide 28 text

Mermaid

Slide 29

Slide 29 text

Mermaid

Slide 30

Slide 30 text

Mermaid

Slide 31

Slide 31 text

Not only Redocly! draw.io

Slide 32

Slide 32 text

draw.io

Slide 33

Slide 33 text

Can see changes in PR

Slide 34

Slide 34 text

Can see changes in PR

Slide 35

Slide 35 text

DEV DEV DEV API Changes

Slide 36

Slide 36 text

DEV Pull Request DEV DEV Revie w swagger changes API Changes Pull Request kafka spec changes

Slide 37

Slide 37 text

DEV Pull Request DEV DEV Revie w swagger changes Pull Request kafka spec changes Pull Request logic implementation API Changes

Slide 38

Slide 38 text

Even more use case

Slide 39

Slide 39 text

Key Takeaways • Use code as document as much as possible • Make document changes easy to review • Communicate with the team using document

Slide 40

Slide 40 text

No content