RocketWatch Support Template FAQ Integration
General Information
What is the nature of the proposed bounty?
The RocketWatch Bot contains a feature that allows members of the community to create support templates for commonly asked questions or information. These templates can then be displayed for users when the same question comes up again. The contents of some of these support templates are likely useful outside of Discord. Further, they would be easier to evaluate and maintain if present within a GitHub repository over buried in the support bot.
The intent of this bounty is to:
- Evaluate the content of the existing support templates, and determine if any have utility outside of discord.
- Copy any useful content to a more referencable and maintainable source. Ideally the official documentation pages. If for whatever reason this is not possible, move out to a community documentation page.
- Adjust the support template contents to give a short paragraph summary of the answer, and then link to the above documentation page.
The bounty should also include a milestone to determine a maintenance plan, to maintain this parity going forwards.
Why are you writing this bounty proposal?
It’s come up a couple of times while I was looking at the existing documentation-related bounties. There’s a good chance that information that could go in the official FAQs exists within the RocketWatch bot, this is pretty frustrating. We have two sources of information that generally don’t reference each other, and neither of which are maintained reliably. Unifying them to the extent possible is a step towards more effective and maintainable FAQ documentation as the protocol continues to evolve.
Benefit
Group | Benefits |
---|---|
Potential rETH holders | Better maintained FAQs can help rETH holders make an informed choice regarding Rocket Pool. |
rETH holders | Easier time finding information, information more likely to be accurate. |
Potential NOs | Better maintained FAQs can help potential NOs make an informed choice regarding Rocket Pool. |
NOs | Easier time finding information, information more likely to be accurate. |
Community | Easier time finding information, information more likely to be accurate. |
RPL holders | Easier time finding information, information more likely to be accurate. |
Which other non-RPL protocols, DAOs, projects, or individuals would stand to benefit from the bounty being successfully completed?
None.
Work
What steps would be entailed in completing the bounty? Do successful examples of such work exist elsewhere? What skillsets or knowledge will be required?
- Get access to the contents of the RocketWatch support pages. Bot author may be able to help with this, but at a minimum, you can call them all through the bot.
- Review contents, make four lists:
A) This should be on the official FAQ
B) This should be on a community FAQ
C) This should remain solely as a support template entry (maybe be meta-specific to Discord, etc)
D) This is no longer relevant and should be removed from the support bot. - Action the produced lists, focusing primarily on A and B. Clean up entries where needed so that they meet official FAQ quality requirements.
- Determine a robust plan for maintaining parity between the contents of these support pages, and the official and community FAQs.
This is fairly generic organizational / consolidation work, I have no specific examples.
The main skillsets are to have fairly deep RP knowledge, and to be able to effectively review the content.
What advice would you give a bounty hunter working on this bounty?
If you haven’t been in the community for long, consult with some of those who have been here longer, they may have a better idea of which support templates are commonly used.
The RP team will likely want to keep the official FAQs fairly general. It’s likely the very specific in-the-weeds answers that will need to go to a community FAQ.
Should the output of this bounty be available under an open-source license?
Yes.
Costs
How much do you think the completion of this bounty is worth to Rocket Pool (in USD)?
Hard for me to judge, as I don’t have the strongest idea of how much good stuff is buried in the 74 support templates in the bot. Feel free to defer to longer-standing members of the community. If I end up doing the definition, I’ll likely try to get access to the full contents so I have a better idea of how much work there is here.
Perhaps 2k for producing the four lists.
Perhaps another 2-3k to sort out what’s there and get everything into the FAQs.
2k for a maintenance plan that will actually result in parity being maintained. Could be a repeatable bounty, could be a stipend, could go to a committee, etc. Paid half now, half when the first instance of serious maintenance happens.
Total definitely below 10k, probably above 5k, but depends exactly on how valuable the contents of the support pages are.
How much work will be needed to verify this bounty has been completed? What skillsets or knowledge will be required?
May be some amount of work, especially if the entries need to be cleaned up significantly to go on more ‘official’ FAQs. Would need general RP knowledge. The members of the unofficial support team are perhaps good candidates for verifying this.
Structure
How would you structure this bounty, and why?
Milestones that roughly correspond to the steps above. Payouts can go to different people for each milestone, but probably let the completer of the first have first-right-of-refusal on the subsequent milestones. Can be a single bounty definition.
Is this bounty repeatable?
No.
Are there any reasonable circumstances under which this bounty should be withdrawn? Should it expire?
If the bot were retired. Shouldn’t expire.
Conflicts of Interest
Does the person or persons proposing the bounty have any conflicts of interest to disclose? (Please disclose here if you are a member of the GMC or if any member of the GMC would benefit directly financially from the successful completion of the bounty).
Not a member of the GMC. No conflicts of interest I’m aware of.
Will the applicant, or any protocol or project in which the applicant has a vested interest (other than Rocket Pool), benefit financially if the bounty is successfully completed?
No, I don’t think so.