[Proposal] Maintain Ocean Protocol core component documentation

Key Project Data

  • Name of project: Maintain Ocean Protocol core component documentations.
  • Proposal Wallet Address: 0x1491e29aDc7a1aa6F8a7e6da5aC0D77BcD7D859E
  • The proposal in one sentence:
    As Ocean core components that power the ocean economy are constantly evolving, I propose to maintain the documentation for a period of 3 months.
  • Which category best describes your project? Pick one or more.
    • Build / improve core Ocean software

Project Overview

  • What problem is your project solving?

Ocean core components that power the ocean economy are constantly evolving. But, the documentation related to the changes in the Ocean tech stack is not maintained at the same pace. This creates a hurdle for the developers who want to develop applications using Ocean Protocol’s technology.

Currently, the docs related to Core Ocean projects like Aquarius, Ocean.js, Ocean.py, Contracts, Provider are not updated and thus, create an issue for developers who work on these projects. A developer has to wait for the docs to be updated or put their own time to go through the source code and changes in the new release to get their work done. This is a waste of valuable time for the developers.

Documentation is a very crucial part of any cutting-edge tech like Ocean Protocol. Documentation is the entry point for all the developers willing to contribute to the new technology. Ill-maintained docs cause more frequent developer churn. A well maintained and up-to-date documentation will help to save developers’ time and bring in more devs and dapps on Ocean Protocol.

Thus, I propose to regularly maintain all the README.md files, setup guides, dev posts, articles on medium, and all the other relevant channels.

What is the final product (e.g. App, URL, Medium, etc)?

  • All the documentation of the Ocean protocol projects will be up-to-date.
  • Github repositories showcasing the use of Ocean libraries
  • Continuous maintenance of documentation of all the Ocean core components.

Project Deliverables - Category

  • I would keep track of updates and changes in the following projects under Ocean Protocol on Github
  • I will work with Ocean Protocol’s core team to keep the documentation updated and help new developers with solving technical issues related to environment setup and library use.

Project Deliverables - Roadmap

ROI

  • BANG
    • The project will save the time of the developers who use Ocean Protocol’s technology. Assuming that better documentation will save 20% of the time spent on getting started, troubling shooting, going through updates, in a week a full time developer working 40 hrs weekly will be able to save 8 hrs/week. So, in a month savings in terms of Ocean tokens will be 4 * 8 * 30 (hourly pay in $) * 0.5 (Token price/$) = 480 Ocean Tokens/developer. And, in a month 10 developers are benefited so, value = 4800 Ocean Tokens/month.
    • Good quality documentation will increase the outreach in the community and attract more developers and thus foster growth of the Ocean Ecosystem. Assuming that due to better documentation, 2 new developers/month start using Ocean Protocol’s technology and each developer generates a value of 5000 Ocean tokens/month. So, total value generated is 2 * 5000 = 10000 Ocean Tokens/month
    • Based on the above arguments, value generated = 4800 + 10000 = 14800/month. So, value generated for 3 months = 44400 Ocean tokens
  • BUCK
    • The 10,000 Ocean token grants will be used to maintain the documentation for 3 months.
  • CHANCE OF SUCCESS
    • I determine the chance of success to achieve the desired outcome is high based on the fact that I have previously worked with Ocean Protocol’s technology stack.
    • To put in numbers, 90%, though I would aim to complete the work with 100% completion status. I am leaving 10% as a chance of failure because of any unforeseen circumstances that might cause the delay in the delivery of the work.
  • FINAL ROI RATIO
    • BANG/BUCK = 44400/10000 = 4.4
    • 4.4* 90% (CHANCE OF SUCCESS) = 3.96

Team members

Akshay

  • Role: developer
  • Relevant Credentials:
  • Background/Experience:
    • Currently pursuing Master’s degree in Information Technology, University of Stuttgart
    • Worked as a backend developer in trading applications at CLSA from July 2018 to Jan 2021.
    • Completed Bachelor’s degree in Computer Engineering from Pune Institute of Computer Technology, Pune in the year 2018.
    • I have knowledge and hands-on experience in Java, Reactjs, nodejs, python, NoSQL/SQL databases.

Additional Information

  • Involvement with Ocean Protocol community so far:
    • Built PayFait under Data Economy Challenge (1st edition) and won the prize as well.
    • Completed the project datapolis.net under Ocean v3 program.
    • Involved in the Ocean Ambassador Program.
    • Working as a developer for Dataunion.app which is funded by Ocean Protocol under the Shipyard program.
2 Likes