Refract by Fosfor is an enterprise AI platform that brings together the best AI frameworks and templates to prepare, build, train, and deploy high-quality Machine Learning (ML) models for users to experience a seamless and personalized “Build-to-Run” transition on their AI workflows. It reduces up to 70% of the effort for users by accelerating data science, AI, and ML life cycles through no-code automated features that significantly reduce time and effort on pre- and post-model development steps (e.g. data provisioning & prep, model deployment, governance, monitoring, etc).
While I joined the team, Refract was still developing. It cannot be called as in a ‘beta’ or ‘pre-release phase’ but it was still being refined and improved.
The documentation did not reflect recent changes, new functionalities, or deprecated features. The user guide was being maintained as a word file, which definitely wasn’t an idle option. It also lacked accessibility features or failed to align with current design guidelines, hindering usability. The product was also rebranded after few months which also brought its own challenges.
• Documentation Updates: Upon joining the team during the ongoing development phase of Refract, I took immediate action to address the outdated documentation. I conducted a thorough review of the existing documentation and identified gaps in reflecting recent changes, new functionalities, and deprecated features. Working closely with the development team, I updated the documentation to ensure it accurately reflected the current state of the product, enabling users to have access to up-to-date information.
• Improved Documentation Management: Recognizing the limitations of maintaining the user guide as a Word file, I implemented a more efficient documentation management system. I transitioned the User Guide to an Online Help document using Sphinx tool, which is a Python based document generator.
• Alignment with Design Guidelines: Realizing the impact of design consistency on user understanding and engagement, I worked closely with the design team to align the documentation with current design guidelines. This involved updating the visual elements, incorporating the latest brand identity, and ensuring consistent terminology and formatting throughout the documentation. By doing so, I enhanced the visual appeal and user-friendliness of the documentation.
• Rebranding Adaptation: When the product underwent a rebranding process, I actively contributed to the adaptation of the documentation to reflect the new brand identity. This included updating the visual elements, revising the tone of voice to align with the new brand guidelines, and ensuring consistency across all documentation materials.
• Creation of How-To Videos: Recognizing the value of visual content in enhancing user understanding and engagement, I took the initiative to create a series of comprehensive How-To videos for the product. These videos provided step-by-step instructions on various features and functionalities, allowing users to easily grasp complex concepts and effectively utilize the product's capabilities.
Project link: http://refract.fosfor.com/userguide/mosaicai/latest/Intro.html