Context
Planning and development of a knowledge base for one of the largest private banks in Brazil, as part of a project to transform an essentially monolithic architecture into a microservices architecture, acting as the first Technical Writer of the tribe.
Problem
The complexity of the project and the creation of new API products (both internal and external), combined with the situation of multiple squads working simultaneously, brought the need for more strategic analysis and organization of the information architecture, as well as the development of consistent documentation for all products derived from the “new microservices pipeline.”
Contribution
- Planning and organization of the knowledge base at the information architecture level;
- Development of onboarding articles for the project and microservices, using functional and accessible language to bring greater clarity to complex pieces of information;
- Documentation of use cases for internal APIs;
- Promotion of a documentation culture and meetups to achieve synchronization between teams in terms of consistency and standardization;
- Development of documentation templates to speed up and facilitate the work of teams.
Impact
- Direct impact on the organization of information and productivity for five squads that form the project’s tribe;
- The availability of a catalog of microservices, organized around the concept of “Single Source Of True”, allowed more reliability and ease dissemination of the adopted distributed architecture model;
- Greater clarity about the products originating from the new microservices track allowed for a shorter learning curve and streamlined the process of adopting the new APIs.
Contexto
Planejamento e desenvolvimento de um knowledge Base para um dos maiores bancos privados do Brasil, em um projeto de transformação de uma arquitetura essencialmente monolítica para uma arquitetura de microserviços, atuando como primeiro Technical Writer da tribo.
Problema
A complexidade do projeto e a derivação de novos produtos de API (internos e externos), somada a situação de varias squads atuando simultaneamente, trouxe a necessidade de uma análise e organização mais estratégica da arquitetura da informação e o desenvolvimento de uma documentação consistente de todos produtos derivados da nova “esteira de microserviços”.
Contribuição
- Planejamento e organização do knowledge base a nível de arquitetura de informação;
- Desenvolvimento de artigos de onboarding para o projeto e microserviços, através de uma linguagem funcional e acessível, trazendo maior clareza para informações complexas;
- Comportamento investigativo e resolutivo obtendo e organizando informações com stakeholders;
- Documentação de casos de uso para as APIs;
- Disseminação da cultura de documentação e meetups buscando a sincronia entre as equipes em termos de consistência e padronização;
- Desenvolvimento de templates de documentação, buscando acelerar e facilitar o trabalho das equipes.
Impacto
- Impacto direto na organização das informações e produtividade para cinco squads que formam a tribo do projeto;
- A disponibilidade de um catálogo de microserviços, organizados em torno do conceito de “Single Source Of True”, trouxe mais confiabilidade e facilidade na disseminação do modelo de arquitetura distribuída adotado;
- A maior clareza sobre os produtos originados da nova esteira de microserviços diminuiu a curva de aprendizado e agilizou o processo de adoção das novas APIs.