Technical Specification – Optimism Frame for Governance Accessibility

1. Introduction

Project Overview

Develop Farcaster Frame as a scalable governance tool to connect token holders with delegates who share similar values. Delegates answer a series of 'values' questions in a survey format. Token holders also respond to these questions and receive recommendations for delegates with aligned values.

Purpose

The project enhances the broader Ethereum ecosystem. When I receive an airdrop or hold governance tokens on a platform, I am invited to delegate my voting power, but I lack information about the values of the delegate options available. Currently, no such tool exists within the ecosystem, and it is likely to see widespread adoption.

Scope

  • Research (June): Forum post with polls to collect signal and feedback about the idea. Interviews to Optimism governance stakeholders. @Cotabe's doc
  • MVP1 (June): To have more deliverables as early as possible, we can share some designs and user flow in the forum while the frame is being developed.
  • MVP2 (early July); First rough version of the frame.
  • MVP3 (August forward, outside the scope of RaidGuild seed); Additional functionality.

2. Research Component – Research (June)

Market Research

  • Analysis of similar tools and platforms.
  • Competitive analysis.
  • Potential user base and target audience.
    • Create a forum post with polls to collect signals and feedback.
    • Conduct 5-10 Interviews with key stakeholders: OP foundation, OP labs, Delegates, Badgeholders, govnerds, etc.

Technical Research

  • Feasibility studies.
  • Technology evaluation and selection.

User Research

  • User interviews.
  • Surveys and feedback.
  • Usability testing.

3. Content Development – Research (June)

Content Strategy

  • Prepare a forum post for Optimism

Content Creation

  • Detailed content plan.
  • Sample content pieces.
  • Content sources and references.

Content Management

  • CMS setup and configuration.
  • Content lifecycle management.
  • Roles and responsibilities for content updates.

4. Design Specifications – MVP1 (June)

UI/UX Design

Architectural Design

  • System architecture diagram.
  • Component diagrams.
  • Data flow diagrams.

Interaction Design

  • Description of user interactions.
  • Animation and transition details.

5. Software Requirements – MVP2 (early July)

Functional Requirements

  • Detailed description of the software functionality and features.
    • Survey process for delegates
    • Survey process for token holders, matches delegate answers, and provides suggections
  • User roles and permissions.
  • User interactions and use cases.

Non-Functional Requirements

  • Performance requirements.
  • Security requirements.
  • Scalability requirements.
  • Usability requirements.

Technical Stack

  • Frog (for frames)
  • PostgresDB
  • Vercel (as PaaS)
  • Next.js (if required)
    Repo here

6. Implementation Plan – MVP2 (early July)

Deployment Strategy

  • Deployment environments.
  • Continuous integration and delivery setup.

Maintenance and Support

  • Post-launch support plans.
  • Maintenance schedules.
  • Incident management procedures.

7. Software Requirements – MVP3 (August forward)

Functional Requirements

  • Detailed description of the software functionality and features.

    • Track how much OP gets delegates/redelegated through this frame. Here are the key metrics for Optimism in terms of Governance Accessibility:
      • Delegated supply of OP
      • Average OP voted per governance proposal

  • User roles and permissions.

  • User interactions and use cases.

Non-Functional Requirements

  • Performance requirements.
  • Security requirements.
  • Scalability requirements.
  • Usability requirements.

Technical Stack

  • Programming languages.
  • Frameworks.
  • Databases.
  • Third-party integrations and APIs.

8. Implementation Plan – MVP3 (August forward)

Deployment Strategy

  • Deployment environments.
  • Continuous integration and delivery setup.

Maintenance and Support

  • Post-launch support plans.
  • Maintenance schedules.
  • Incident management procedures.

9. Project Management

Development Roadmap

  • Milestones and timelines.
  • Phased development approach.

Task Management

  • Detailed task breakdown.
  • Resource allocation.

Quality Assurance

  • Testing strategies.
  • Bug tracking and resolution process.
  • Acceptance criteria.

10. Conclusion

Summary

  • Recap of key points.

Future Considerations

  • Potential future enhancements.
  • Long-term vision for the project.

11. Appendices

Glossary

  • Definitions of technical terms and acronyms.

References

Additional Documentation

  • Links to related documents and resources.
Select a repo