Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
titleTechnical Writers - Stay Tuned

Mifos is applying for participation in Season of Docs once again. Check back in on March 31, 2023 to see if we have been accepted. 

About Mifos

The best way to understand what we do is to watch a few videos. 

What is Mifos and What Does our Community Do?

Widget Connector
urlhttps://www.youtube.com/watch?v=3fG_NJuZLSo&list=PLAfz_RVd88Foe14MhI_7feIyOBIwyMdbr&index=1

Widget Connector
urlhttps://www.youtube.com/watch?v=aebD3wtMl0A&list=PLAfz_RVd88Foe14MhI_7feIyOBIwyMdbr

How is the Mifos software used? 

Widget Connector
urlhttps://www.youtube.com/watch?v=STQpP2GhK8k
  

   

2023 Season of Docs Timeline

Please see Google Season of Docs website for the full program timeline. Here are a few key dates and their current status:

...

March 31, 2023 - November 13, 2023

Hired technical writers work on documentation projects with guidance from organizations

...

About the Mifos Initiative

The Mifos Initiative is a global 501(c)3 fintech non-profit  leveraging the cloud, mobile & open source community to democratize financial services worldwide and digitally transform the world’s 3 billion poor and underbanked. We aim to create a world of 3 Billion Maries where everyone has access to the financial resources needed to create a better life for themselves and their family. Our unprecedented approach unites financial institutions, local technology partners, and volunteer developers to collectively advance open source banking infrastructure to sustainably build impactful innovations in digital financial services.

We guide the global Mifos ecosystem of partners and volunteers contributing back to the open source Mifos and Fineract platforms. Mifos donated the codebase to the Apache Software Foundation for what ultimately became the top-level project, Apache Fineract. Both Mifos and Fineract have been nominated and selected by the Digital Public Goods Alliance as foundational digital public goods for the Financial Inclusion Community of Practice. 

More than 25 million clients supported by 400+ fintechs and financial institutions use our open APIs to power their solution across 56+ countries. They are supported by a global community of 100 deployment partners & hundreds of volunteers.

Mifos  is the innovation that powers the innovators by providing a set of open source building blocks that can be composed into financial services of any form. Across the world from grassroots microfinance institutions in rural Africa serving dozens of clients with microloans to government-led banks in Latin America reaching millions to banks in Germany delivering mortgage loans, from digital credit startups reaching hundreds of thousands in West Africa to mobile wallet providers supporting millions in India, to cloud-based core banking systems reaching millions across multiple continents to banking as a service providers enabling neobanks, our open banking stack is transforming the delivery of digital financial service

For the past 15 years, we’ve been at the forefront of transformative technology, building an end to end open source stack for DFS. Our technology stack provides complete banking infrastructure that is cloud-native, mobile-enabled, and scalable to billions that are underbanked. Our stack is a set of Open Source Lego Blocks for DFS including flexible account management (Mifos X) leveraging Open APIs from Apache Fineract and Fineract CN, integrating with digital payment rails like Mojaloop, delivered via web and mobile apps through Open Banking APIs.  

At the heart of our stack is Fineract 1.x, our  composable open source core banking platform that is highly scalable in the cloud and deployable via our reference apps and open APIs.  Coupled with our Mifos web app UI on top of these platforms, We provide a flexible account and wallet management system to enable the delivery of any digital financial service. Next in our stack is our Payment Hub EE which provides a gateway and orchestration engine to connect to real-time payment services and interoperable payment rails like Mojaloop and Mobile Money APIs  Think of Mifos as the DNA of financial services that can be put together into many expressions and Mojaloop as the connective tissue enabling low-cost payments across any system. On top of these open source rails and accounts are reference customer-facing mobile banking and mobile wallet apps which consume our Open Banking APIs and third party PISP APIs. We provide these open source building blocks of financial inclusion, train and certify a network of partners to build solutions with these building blocks, and support and sustain the collaborative infrastructure and ecosystem for these solutions to be scaled and distributed worldwide. 

Documentation audiences across our community include the end users of our software, the staff of financial institutions and fintechs that use Mifos to create customers and their accounts, configure loan and savings products, process transactions and track repayments and deposits, manage their general ledger and generate financial and operational reports. The primary audience of our documentation is our partner community who host, deploy, configure, and support the software for these financial institutions, build new fintech solutions and applications using the APIs, and develop, maintain, and extend the core upstream project which powers their solutions. Joining these partners as part of our developer community are individual volunteers, interns, and corporate strategic partners who collectively guide the development, QA, and release management to ensure timely and high-quality open source releases of our platform.

Our Problem & Need

Based on learnings from our previous Season of Docs participation and the progress made in 2021 with documentation consolidation and the progress made in 2022 around technical documentation for the revamped Fineract and Mifos releases, our 2023 Season of Docs will focus on documentation to improve the Developer Experience for all contributors to innovators of our project. 

As the breadth of our solution stack grows from microfinance to loan management to core banking to payment orchestration and the breadth of our use cases supported extend behind the private sector to public sector use cases around Digital Public Goods and Digital Public Infrastructure like G2P Payments, the need for improved documentation to enable a smooth developer experience is ever growing.

The audience for this improved developer documentation includes many different stakeholders and developer personas ranging from:

  • New Contributors - volunteers, interns, or anyone new to the project seeking how they can contribute to the the various solutions we have around core banking, mobile wallets, payment orchestration, G2P payments, etc. 
  • Developers Training
  • Fintech Innovators
  • Customers - 

...


Info
titleTechnical Writers - Stay Tuned

Mifos is applying for participation in Season of Docs once again. Check back in on March 31, 2023 to see if we have been accepted. 

About Mifos

The best way to understand what we do is to watch a few videos. 

What is Mifos and What Does our Community Do?

Widget Connector
urlhttps://www.youtube.com/watch?v=3fG_NJuZLSo&list=PLAfz_RVd88Foe14MhI_7feIyOBIwyMdbr&index=1

Widget Connector
urlhttps://www.youtube.com/watch?v=aebD3wtMl0A&list=PLAfz_RVd88Foe14MhI_7feIyOBIwyMdbr

How is the Mifos software used? 

Widget Connector
urlhttps://www.youtube.com/watch?v=STQpP2GhK8k
  

   

2023 Season of Docs Timeline

Please see Google Season of Docs website for the full program timeline. Here are a few key dates and their current status:


Program announcementJanuary 18, 2023
Season of Docs program announced
Organization applicationsFebruary 15, 2023 at 18:00 UTC
Organizations can begin submitting applications to Google

March 24, 2023 at 18:00 UTC
Deadline for organization applications

March 24 - March 30, 2023
Google program administrators review organization applications
Organizations announcedMarch 31, 2023 at 18:00 UTC
Google publishes the list of accepted organizations
Doc developmentMarch 31, 2023
Doc development can officially begin
Technical writer hiringMay 10, 2023
Technical writer hiring deadline
Technical Writing

March 31, 2023 - November 13, 2023

Hired technical writers work on documentation projects with guidance from organizations

Monthly EvaluationsOrganization administrators begin to submit monthly evaluations to report on the status of their project
Final project evaluation and case studyNovember 6 - November 21, 2023 at 18:00 UTC
Organization administrators submit their case study and final project evaluation
Results announcedDecember 5, 2023
Google publishes the 2021 Season of Docs case studies and aggregate project data
Followup surveysMay 1, 2024
Organizations begin to participate in post-program followup surveys


Anchor
proposal
proposal
2023 Proposal - Improve Developer Experience for all Contributors & Innovators  

About the Mifos Initiative

The Mifos Initiative is a global 501(c)3 fintech non-profit  leveraging the cloud, mobile & open source community to democratize financial services worldwide and digitally transform the world’s 3 billion poor and underbanked. We aim to create a world of 3 Billion Maries where everyone has access to the financial resources needed to create a better life for themselves and their family. Our unprecedented approach unites financial institutions, local technology partners, and volunteer developers to collectively advance open source banking infrastructure to sustainably build impactful innovations in digital financial services.

We guide the global Mifos ecosystem of partners and volunteers contributing back to the open source Mifos and Fineract platforms. Mifos donated the codebase to the Apache Software Foundation for what ultimately became the top-level project, Apache Fineract. Both Mifos and Fineract have been nominated and selected by the Digital Public Goods Alliance as foundational digital public goods for the Financial Inclusion Community of Practice. 

More than 25 million clients supported by 400+ fintechs and financial institutions use our open APIs to power their solution across 56+ countries. They are supported by a global community of 100 deployment partners & hundreds of volunteers.

Mifos  is the innovation that powers the innovators by providing a set of open source building blocks that can be composed into financial services of any form. Across the world from grassroots microfinance institutions in rural Africa serving dozens of clients with microloans to government-led banks in Latin America reaching millions to banks in Germany delivering mortgage loans, from digital credit startups reaching hundreds of thousands in West Africa to mobile wallet providers supporting millions in India, to cloud-based core banking systems reaching millions across multiple continents to banking as a service providers enabling neobanks, our open banking stack is transforming the delivery of digital financial service

For the past 15 years, we’ve been at the forefront of transformative technology, building an end to end open source stack for DFS. Our technology stack provides complete banking infrastructure that is cloud-native, mobile-enabled, and scalable to billions that are underbanked. Our stack is a set of Open Source Lego Blocks for DFS including flexible account management (Mifos X) leveraging Open APIs from Apache Fineract and Fineract CN, integrating with digital payment rails like Mojaloop, delivered via web and mobile apps through Open Banking APIs.  

At the heart of our stack is Fineract 1.x, our  composable open source core banking platform that is highly scalable in the cloud and deployable via our reference apps and open APIs.  Coupled with our Mifos web app UI on top of these platforms, We provide a flexible account and wallet management system to enable the delivery of any digital financial service. Next in our stack is our Payment Hub EE which provides a gateway and orchestration engine to connect to real-time payment services and interoperable payment rails like Mojaloop and Mobile Money APIs  Think of Mifos as the DNA of financial services that can be put together into many expressions and Mojaloop as the connective tissue enabling low-cost payments across any system. On top of these open source rails and accounts are reference customer-facing mobile banking and mobile wallet apps which consume our Open Banking APIs and third party PISP APIs. We provide these open source building blocks of financial inclusion, train and certify a network of partners to build solutions with these building blocks, and support and sustain the collaborative infrastructure and ecosystem for these solutions to be scaled and distributed worldwide. 

Documentation audiences across our community include the end users of our software, the staff of financial institutions and fintechs that use Mifos to create customers and their accounts, configure loan and savings products, process transactions and track repayments and deposits, manage their general ledger and generate financial and operational reports. The primary audience of our documentation is our partner community who host, deploy, configure, and support the software for these financial institutions, build new fintech solutions and applications using the APIs, and develop, maintain, and extend the core upstream project which powers their solutions. Joining these partners as part of our developer community are individual volunteers, interns, and corporate strategic partners who collectively guide the development, QA, and release management to ensure timely and high-quality open source releases of our platform.

Our Problem & Need

Based on learnings from our previous Season of Docs participation and the progress made in 2021 with documentation consolidation and the progress made in 2022 around technical documentation for the revamped Fineract and Mifos releases, our 2023 Season of Docs will focus on documentation to improve the Developer Experience for all contributors to innovators of our project. 

As the breadth of our solution stack grows from microfinance to loan management to core banking to payment orchestration and the breadth of our use cases supported extend behind the private sector to public sector use cases around Digital Public Goods and Digital Public Infrastructure like G2P Payments, the need for improved documentation to enable a smooth developer experience is ever growing.

The audience for this improved developer documentation includes many different stakeholders and developer personas ranging from:

  • New Contributors - volunteers, interns, or anyone new to the project seeking how they can contribute to the the various solutions we have around core banking, mobile wallets, payment orchestration, G2P payments, etc. 
  • Developers Training - as financial institutions, integrators, governments, fintechs or any consumers of our software, start to use our 
  • New Partner Onboarding - Local system integrators and partners deploying, localizatin, hosting, and supporting solutions powered by our open source projects need to self-equip themselves with the requisite knowledge and need better orientation in doing this a technical level. 
  • Fintech Innovators - Fintechs of all sizes need to be able to imagine and bring to life the many different DFS and fintech solutions that can be powered by our building blocks and require a smooth developer experience and sandbox environment to do so. 
  • Customers - For the IT staff of public and private sector customer evaluating our solutions and DPGs, they need a smooth and optimal experience to test out and experience our software. Evaluating the syste
  •  

For all of these technical stakeholders, we want to provide the smoothest developer experiences so they can:

  • Discover the broad capabilites of our solution stack
  • Envision what use cases it can support and the solutions they can bring to life
  • Effectively install the system and set up their development environment
  • Communicate, collaborate and contribution effectively with the community according to our community standards. 
  • Understand the value of and follow the best practices around upstream development to ensure a virtuous cycle.
  • Extend the platform or build new solutions via our Open APIs and SDKs
  • Sustainably scale these solutions in the cloud or on-premise environemnts using our DevOps tooling.

To overcome some of the challenges we faced in previous Season of Docs programs requiring heavy subject matter expert or developer participation to equipethe technical writers with the proper functional domain or technical knowledge, the focus of this year's proposal will be more around the developer experience - from setup and installation, to collaboration and communication norms with the community, contributions standards and processes, and how to extending and building solutions using our APIs, and deploying these solutions in the cloud. This focus will reduce dependencies on our community around technical and domain knowledge yet require technical writers who have a strong technical background, including those with previous experiences as a software developer.


Contribution Guide

  • Reference an example 

Installation & Setup

  • Across each of the apps

Deployment in the Cloud

Contribution Experience

  • Reproting bugs
  • Requesting New Features
  • Designing New Features 
  • Submitting Pull Request
  • Coding Standards & Tools

Testing Process 


Using our Developer/Innovator Toolkit

  • Integrating with other Systems
  • Connecting Channel Applications
  • Extending the system via Customer Modules
  • Building new via the API
  • Building Solutiosn using our SDK

API Docs

Building from the API

Using Custom Modules

For Season of Docs, where I think we could use a technical writer is to help with more of our documentation around developer experience - getting environment setup, installation guides, deployability and DevOps tools, what SDKs we have and how to interact, how to use the API, custom modules,  contribution process, coding standards, upstream development, etc.So moreso helping to onboard new contributors/developers - could be volunteers, could be staff, could be partners, could be fintechs implementing.I This topic area could be one in which the technical writer might not need the domain knowledge but they would require the DevOps/dev knowledge.


contributing to the project,   required The focus of our documentation leveraging this existing documentation as foundational componen This project will build off of the 2021 Season of Docs project which consolidated our documentation into one unified portal with separate spaces for developer and user documentation. 

...