Software project documentation: 30% quicker new features implementation

Innowise has developed project documentation for comprehending a software system’s architecture, structure, and components.

Customer

Industry

Banking

Region

Client since

2023

Our client is a prominent player in the banking payment system sector, operating in a highly competitive and dynamic market. They are known for their forward-looking approach to financial technology and have a significant presence in their domain.

Detailed information about the client cannot be disclosed under the terms of NDA.

Challenge

Bringing the documentation gap

The client was gearing up to acquire ISO certifications, a critical step in enhancing their market credibility and operational efficiency. However, they hit a major roadblock: the absence of comprehensive software project documentation. This gap was not just a hurdle for certification but also a bottleneck in improving their operations. New team members struggled with onboarding, and developers wasted precious time unraveling system complexities for every new feature addition.

Moreover, the lack of clear documentation was a significant barrier in communication between stakeholders, developers, and system maintainers. The client’s expectation from us was not just to fill this gap but to create a robust foundation that would facilitate future system enhancements and maintenance.

Solution

Providing project software documentation for enhanced system understanding and efficiency

At Innowise, we got down to collecting and documenting the intricate details of the client’s software system. Our solution comprised three key components: software requirements specification (SRS), solution architecture document (SAD), and design standards. Throughout the process, developers on the client’s side collaborated with us, providing valuable insights into system structure, data formats, process features, and more.

Software requirements spesification (SRS)

Our team’s first task was to get a holistic understanding of the client’s business objectives and system requirements. This phase was about painting a comprehensive picture of what the system meant to achieve in the broader context of the client’s business operations.

Defining the business and system purpose

We began by defining the business and system purpose. This was crucial to aligning the software’s functionalities with the client’s strategic objectives. We conducted in-depth discussions with key stakeholders to confirm that our understanding was accurate and encompassed future aspirations. This thorough understanding allowed us to anticipate not just current but future requirements as well.

Laying out functional requirements

Next, we outlined the functional requirements in a carefully structured format that detailed every aspect of the system’s functionality – from basic calculations to complex data processing algorithms. These requirements were prioritized based on their impact on the system’s overall effectiveness and the client’s operational efficiency.

Use cases and BPMN diagrams

To complement our textual descriptions, we employed user cases and business process model and notation (BPMN) diagrams. These tools were invaluable in visualizing the system’s operations, providing a graphical representation of workflows and processes. The use cases offered real-world scenarios that helped understand how different users would interact with the system, while the BPMN diagrams offered a more technical view of the process flows within the system.

Comprehensive documentation of components and features

Our team didn’t stop at the high-level requirements. We delved into the details, documenting every component and feature of the system. This exhaustive documentation covered everything from user interface elements to back-end processes. We aimed to ensure developers and system maintainers could understand and navigate the system easily.

Solution architecture document (SAD)

Following the development of the software requirements specification, our focus shifted to crafting the solution architecture document.

Bridging technical needs and business objectives

Technical projects face significant challenges aligning technical aspects with business objectives. Our document played a pivotal role in bridging this gap. By clearly outlining how each element of the system architecture directly contributed to the business goals, we provided a clear justification for architectural decisions.

Documenting the current technology state

An essential part of our approach was to document the current state of technology within the client’s system. This involved a thorough analysis of the technologies, frameworks, and tools employed in creating the system. We evaluated their effectiveness, scalability, and how they integrated with other components of the system. This analysis was critical in identifying areas of improvement and ensuring that the proposed architecture was built on a solid and modern technological foundation.

Design standarts

The final piece of our documentation puzzle was the design standards. This section was crucial as it defined the payment system’s visual and functional identity.

Detailed aesthetic descriptions

We began with the aesthetic aspects, documenting the color schemes, typography, and overall visual language used in the system. This wasn’t just about listing colors and font names, we delved into the psychology behind these choices, explaining how they align with the brand identity and user experience goals. For example, we detailed why specific shades were chosen for their visual appeal and potential psychological impact on users, enhancing usability and user engagement.

Functional elements and interactions

Moving beyond aesthetics, we explored the functional elements. This included field names, headers, and the layout of information on each screen. We looked into detail about the design of interactive elements like buttons, sliders, and dropdown menus, documenting their operation in different states (e.g., hovered, clicked, inactive). Our aim was to ensure consistency and intuitiveness in user interactions throughout the system.

Notifications and pop-up screens

We detailed the design of pop-up messages for errors and action confirmations, ensuring they were visually consistent and conveyed clear, concise, and helpful information. We also focused extensively on the notification system, which included email alerts and in-system notifications. This involved detailing the design of email templates, the tone of the messages, and the triggers for these notifications. We ensured that these notifications were not only informative but also designed in a way that reflected the brand’s voice and enhanced the overall user experience.

Process

Discovery phase

We kicked off with a discovery phase, thoroughly understanding the client's system and requirements. This involved creating a detailed project roadmap, setting clear milestones, and identifying potential challenges and solutions to achieve a smooth documenting experience.

Documentation phase

During the documentation phase, we produced the SRS, SAD, and design standards. This phase was iterative, involving constant validation and refinement.

Communication and tools

Communication was key. We leveraged various channels like video calls, emails, and collaborative platforms for constant interaction. Task tracking was managed through Jira, maintaining transparency and timely progress.

Team

Business Analyst

UI/UX Designer

Architect

Results

30% quicker new features implementations and streamlined onboarding process

The solution we provided for the banking payment system was comprehensive and multifaceted, and led to tangible and impactful results. First of all, the client is now on the verge of achieving ISO certification. Secondly, our comprehensive documentation improved the onboarding process for newly hired team members. More so, it has resulted in a more fluid integration of new features, markedly saving time and reducing the learning curves for developers.

The reduced complexity and enhanced clarity in system operations mean that the team can focus more on innovation and less on navigating existing structures. Lastly, the clarity in system functionalities, requirements, and restrictions has greatly improved system understanding and communication among all stakeholders.

Project duration

October 2023 - December 2023

30%

quicker new features implementation

faster onboarding process

Related cases

Contact us!

Book a call or fill out the form below and we’ll get back to you once we’ve processed your request.

What happens next?

Having received and processed your request, we will get back to you shortly to detail your project needs and sign an NDA to ensure the confidentiality of information.

After examining requirements, our analysts and developers devise a project proposal with the scope of works, team size, time, and cost estimates.

We arrange a meeting with you to discuss the offer and come to an agreement.

We sign a contract and start working on your project as quickly as possible.