Boosting Development Quality through Continuous Documentation Integration

Transcript

1. Boosting Development Quality through Continuous Documentation Integration

2. Have you seen anything like this?

3. Have you seen anything like this?

4. • How can we improve document? • How can we

   use it to improve development quality? Agenda

5. Swagger generator Swaggo

6. Swagger generator

7. Swagger generator

8. Swagger generator

9. Swaggo Code Swagger YAML

10. Swaggo Swagger YAML DEV DEV

11. QA Other Dev team DEV DEV Swagger YAML

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

    Swagger YAML Swaggo Swagger YAML

13. Swagger YAML Swagger YAML Swagger YAML Document Portal QA Other

    Dev team DEV DEV

14. Docusaurus

15. What is Docusaurus?

16. What is Docusaurus? • Static website generator • Markdown based

    • React component support, we can do many things with this!

17. Docusaurus + Redocly

18. Redocly

19. Integrate with CI/CD DEV push code Swagger YAML Git

20. Integrate with CI/CD DEV push code deploy application pipeline Git

    Kubernetes Swagger YAML

21. Integrate with CI/CD DEV push code deploy application pipeline document

    pipeline build grab swagger files Git Kubernetes Swagger YAML

22. Integrate with CI/CD document pipeline build application pipeline application pipeline

    application pipeline when dev env deployed

23. Docusaurus + Redocly

24. Database spec

25. Database spec

26. Kafka spec

27. Not only Redocly! Mermaid

28. Mermaid

29. Mermaid

30. Mermaid

31. Not only Redocly! draw.io

32. draw.io

33. Can see changes in PR

34. Can see changes in PR

35. DEV DEV DEV API Changes

36. DEV Pull Request DEV DEV Revie w swagger changes API

    Changes Pull Request kafka spec changes

37. DEV Pull Request DEV DEV Revie w swagger changes Pull

    Request kafka spec changes Pull Request logic implementation API Changes

38. Even more use case

39. Key Takeaways • Use code as document as much as

    possible • Make document changes easy to review • Communicate with the team using document
40. None