apidays London 2023 - DocOps and Automation in Fintech, Kateryna Osadchenko, Kindred Group

apidays London 2023 - APIs for Smarter Platforms and Business Processes
September 13 & 14, 2023

DocOps and Automation in Fintech: A tech writer's perspective
Kateryna Osadchenko, Content Designer at Kindred Group PLC

------

Check out our conferences at https://www.apidays.global/

Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8

Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io

Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/

Transcript

1. September 2023 DocOps and automation in Fintech: a tech writer's perspective Kateryna Osadchenko Technical writer, content designer
2. Document Operations aka DocOps is a set of practices that works to automate and integrate the process of developing documentation across engineering, product, support, and technical writing teams.
3. BIGGER STRUCTURE BIGGER DOCS BIGGER NEED FOR AUTOMATION
4. We’ve got docs. What now? We need tech writers on board to create a link between engineering, product, and support teams. Tech writers make sure that docs are treated as an integral part of the fi nal product/service and follow some key principles.
5. Accuracy and Compliance: You must align with your industry regulatory requirements. Agility: Keep pace with SDLC and API integrations. User-Centricity: Prioritize ease of use and application. Collaboration: Work closely with cross-functional teams.
6. Adopting DocOps
7. Identify the main pain points: • How do we align more with our engineering roadmap and SDLC? • How do we track updates and collaborate across teams more e ff i ciently? • What is consuming excessive resources in delivering and updating API docs? • Frequently broken docs? Seek feedback from teams closest to user issues.
8. Deciding what to automate
9. Consider factors Initial Need: Assess the urgency and frequency of tasks > docs and code samples reviews, editing, testing. Impact of Automation: Weigh the bene fi ts of automation versus manual e ff orts. Available Resources: Collaborate with developers, SMEs, and business owners. Budget and Long-Term Planning: Allocate resources > tech writer + Dev/QA/ PO…
10. Automation in action
11. What kicked things o f Streamline documentation deployment with version control tools in a fi tting format (markdown, json) to ensure real-time updates. Link code snippets in docs directly to the codebase, re fl ecting real-time changes Linters to fl ag broken links, errors, stylistic errors or questionable constructs. Get a developer or a tech-savvy writer on board to drive and advocate for adopting a version of DocOps fi tting your needs, resources, and ambitions.
12. Is there a bare minimum for DocOps?
13. • Depends on the size of the documentation set, how many docs you have. • Industry are you in. • There is no one-size- fi ts-all solution. • Your use case and what your docs actually need to do. • Tech sassy writer/writer-developer on board to advocate for DocOps. • Less theory, more practice.
14. What did we learn
15. Embracing DocOps and automation in fi ntech documentation is about adapting to your dev environment. Fostering collaboration and empathy, seeking feedback, and making strategic decisions on what to automate. Your need and ability to automate directly correlates with your structure, available resources and collaboration level between teams.