All companies/customers have an established change flow for deploying components to the production environment, some more complicated and bureaucratic than others.
Where I work, the change flow to deploy to production was a very tedious and manual process. Although there were automated pipelines in jenkins to deploy components to production, in the Jira ticket the components to be deployed had to be documented, for auditing, security and to ensure a correct rollback in case the deployment to production failed.
Because of this, the following problems were identified
- Very long time for the Jira ticket generation and documentation, as well as other manual steps, such as the interaction with bitbucket.
- Manual errors in documentation generation and/or omission of steps.
- Developers felt that we were wasting a lot of time doing documentation (repetitive in many occasions).
AutoDoc, emerged from the need to solve these problems, becoming a tool that helps us in the generation of the Jira ticket and in the documentation of the components that would go to production, automatizing many of the manual tasks:
- The time to generate and document tickets to production was reduced by 95%.
- Human error in ticket generation and documentation was eliminated.
- The time gained with AutoDoc was invested in the development of much more robust and optimised components.
Languages/Technologies:
- C# (netcore)
- Javascript (ES6)
- Python
- Api Rest
- Jira
- Bitbucket
- OOP
- SOLID, Clean Code
- Git
- Bash
- JSON