erxes (current version 1.0, first release in 2016) is a free and open fair-code licensed experience operating system (XOS). erxes started as a Marketing Technology platform, but due to marketing being inextricably linked to other aspects of business we have decided to expand our scope to include the most valuable aspects of an organization, the creation of experiences .The scope of our operations have shifted to experience management since our launch and is now focused on the experience ecosystem.
The current erxes platform is plugin based architecture, serverless, and fully cloud compatible to provide all stakeholders with the flexibility, scalability, and freedom to achieve the full potential of their team.
By adopting a serverless and plugin based architecture, erxes provides more options for open source developers and agencies. As a large part of improving experiences across the board we are dedicated to heightening developer experience. One of the largest issues that open-source software faces is the complexity and size of projects. Using plugins-based architecture and separating the core program provides a lower barrier of entry. Thus, developers can start out small and scale up as they expand. Our contributors are developers and independent agencies that want to step into the world of open source development. Our users range from small to medium sized companies and enterprises.
About our project
Our project’s problem
In recent months our development team has been tirelessly working on the upcoming release of erxes 1.0. The 1.0 release expands upon our platforms greatly and is a shift towards our dedication to open source. However, it does introduce significant changes to how the project is developed. We have fully embraced the need to have a better developer experience for open source developers working on the erxes platform. As such, improving and expanding on our documentation will benefit the developers and agencies that wish to step into the world of open source development.
Our project’s scope
The erxes 1.0 project will:
- Audit the existing documentation to determine what is still relevant and what needs to be adjusted to meet the developer experience of our 1.0 version launch.
- Collaborate with our support team to evaluate and create new guidance materials that will provide guidance for developers regarding our new version.
- Develop a streamlined documentation architecture to improve developer experience
- Create a plugin development guide for new developers starting out in open source development for enterprise software.
- Expand on documentation in regards to the most common issues reported in support tickets.
- Work with the support teams to create a standardized process for documentation going forward to streamline the documentation process.
Work that is out-of-scope for this project:
- This project will not delve into the SaaS and Enterprise parts of our platform and will only produce documentation that will assist open source developers.
It will take approximately four months to complete this part of the project. We are actively seeking technical writers to head the project and the support teams for the writer are already in place. Our product development and writing teams are fully backing this project and will act as support personnel for the writer.
Measuring our project’s success
We are looking to increase the overall number of developers contributing to our documentation. We are of the opinion that structured and streamlined documentation will increase the number of new developers contributing plugins to the marketplace.
We will be tracking both the number of new contributors and the number of new plugins on a quarterly basis.
The project can be considered successful when:
- The number of new contributors increases by 10%
- The number of plugins by open source developers increases by 20%
We estimate that it will take 6 months to complete the project. The tech writer will have to go through orientation and an introduction to our values and messaging framework. Once that is complete we can move on to auditing and updating our documentation.
Action Item 1: Orientation
Action Item 2: Audit existing documentation and create friction log
Action Item 3:Use the friction log to collaborate with our support team to create new guidance materials that will provide guidance for developers regarding our new version.
Action Item 4: Develop a streamlined documentation architecture to improve developer experience (DX)
Action Item 5: Create a plugin development guide for new developers starting out in open source development for enterprise software.
Action Item 6: Expand on documentation in regards to the most common issues reported in support tickets.
Action Item 7: Work with the support teams to create a standardized process for documentation going forward to streamline the documentation process.
erxes 1.0 project budget
Technical writer audit, expansion, update, and release of documentation for erxes 1.0
This will be a significant undertaking and the writer will have to be fairly compensated
4 volunteer stipends x 500 each, volunteers will be needed to lessen the workload for the writer
Design work for documentation site
The designer will work to align the documentation site with our brand guidelines and to increase ease of navigation
Throw the support team a pizza party for their contributions to the documentation process
Our marketing team includes 2 marketing copywriters, one of whom will assist the technical writer and work as our liaison. As they are the person that produced the messaging framework we believe that they can bring the technical writer up to speed the fastest regarding our messaging and positioning.