Over the course of several months the Success team at Parity has curated an extensive list of User Stories that have stemmed from feedback collected from multiple channels, key ecosystem players, summits and more.
These user stories are based on widely felt needs with qualified potential impact, making it crucial that Parity is not a bottleneck in solving these user stories; and for the community to take the lead.
What are Ecosystem User Stories?
A user story is an informal, general explanation of a software feature written from the perspective of the end user. Its purpose is to articulate how a software feature will provide value to the customer.
Ecosystem User Stories - #1 - Establish comprehensive XCM development standards and documentation.
I [developer] want [to be able to easily digest XCM documentation] so that [we can achieve a better standard of knowledge and XCM best practices for current & future developers building in the Polkadot Ecosystem]
What’s the goal?
-
Establish comprehensive XCM Development Standards and documentation using real world examples and use cases from the community.
-
For the community to voice its needs for what we’d like to see improved with the current documentation.
To invite quality to Polkadot, we need to provide quality.
The end game is to maintain and ensure a high quality of knowledge sharing, use cases and examples surrounding XCM, as well as ensuring these are easily accessible. This benefits not just current, but future developers looking to build on Polkadot. If we want to produce and attract high quality, we must lead by example.
How does solving this issue impact the ecosystem?
-
An upskill in standards across the ecosystem.
Using working, real world examples of successful XCM use cases should demonstrate the level of quality we aim to strive for as an ecosystem.
-
Increased Adoption of XCM by new developers.
Ensuring that the docs are up to date, easy to read and easily accessible whilst demonstrating real use cases helps convince wandering and curious developers that Polkadot is the home they should choose.
-
Showcases & highlights the current use cases of XCM within the ecosystem.
Showcasing that XCM works & is currently used by our community demonstrates Polkadot’s unique value proposition, and serves as a reference point for aspiring Polkadot developers.
How can we do this?
I’m asking that as a community we begin to solve these user stories ourselves. I propose that this post be the first, of hopefully many, of this new initiative.
To begin I’d like to open up a discussion on the current status of our current XCM docs, ideas on how to improve them and examples of the community using XCM. I’ve provided a [optional] template for us to use to help organise the feedback.
Template
Concise title: [ Title of XCM use case example / Title of potential XCM use case example]
Author: [Input Name / username]
Date: [Today’s date]
Please choose one of the following sections to contribute to
1. An example of a real, currently active, XCM use case
2. An Edu-video / Resource of XCM - E.G: [HrmpInitChannelOpen] / [HrmpInitChannelAccept]
3. An example of a potential future XCM use case
4. Best practices for standardisation
Target Audience & Benefits: Who does your contribution benefit & why? [Polkadot beginners, Intermediate, developers or experts?
Concluding remarks
I urge anyone who sees the benefits of improving the current XCM docs to contribute, in your own way or using the template. Either way a dialogue on how we can start to solve these issues is imperative.
Establishing comprehensive XCM development standards is just one opportunity within the ecosystem that needs to be solved. With the knowledge in the community we can start to solve these issues one by one.