over budget
Aiken Alive: A Living Guide to Aiken Smart Contract Development
Current Project Status
Unfunded
Amount
Received
₳0
Amount
Requested
₳75,000
Percentage
Received
0.00%
Solution

Create an interactive ‘living guide’ that clarifies existing docs, shares real-world learnings from our team’s Aiken devs experience, provides building blocks for a community platform to collaborate.

Problem

Existing Aiken documentation, while helpful, lacks practical insights & usage examples needed for devs to efficiently build smart contracts. More robust resources are needed to grow the community.

Impact Alignment
Feasibility
Value for Money

Team

2 members

Aiken Alive: A Living Guide to Aiken Smart Contract Development

Please describe your proposed solution

Our solution is to create an interactive 'living guide' for Aiken smart contract development. This will be a website that accomplishes the following:

  1. Clarifies and expands on existing Aiken documentation with practical insights
  2. Shares our team's real-world learnings, best practices, and pitfalls to avoid based on our extensive experience building with Aiken and our talks with other devs
  3. Provides detailed usage examples and tutorials for key Aiken concepts, libraries and new features
  4. Allows developers to comment, ask questions and share their own experiences, creating a collaborative community resource
  5. Will be continuously updated as we deepen our Aiken knowledge and gain feedback from the community

The guide will cover key topics like Aiken smart contract best practices, using the Aiken standard library, working with new features like EMNC and aiken mood, and more. Content will target both beginner and advanced developers.

All materials will be fully open-source. We'll use GitHub to store the website source code, and the site itself will have clear commenting/feedback mechanisms to make it a living community resource.

Please define the positive impact your project will have on the wider Cardano community

This project will make building on Aiken more efficient and accessible for developers of all skill levels. By supplementing official documentation with practical insights and an interactive community layer, we can accelerate Aiken learning and adoption.

Specific impacts include:

  • Faster, easier onboarding for new Aiken developers
  • Fewer development hurdles and wasted effort from learning best practices
  • Increased Aiken smart contract quality and security
  • Community collaboration and knowledge sharing
  • More developers building on Cardano

We'll measure impact through site metrics (visits, time on site, return visits, comments), GitHub stars/forks, and community surveys on Aiken development experience. The ultimate goal is more and better Aiken smart contracts deployed on Cardano.

What is your capability to deliver your project with high levels of trust and accountability? How do you intend to validate if your approach is feasible?

Our team is uniquely qualified to create this living Aiken guide based on our deep experience with the language. We're already building marketplace functionalities using Aiken (through a funded Catalyst proposal), and have encountered the need for this project firsthand.

We're already documenting our Aiken learnings internally - this project will allow us to share them widely and incorporate community insights. Our developers have built numerous successful projects and have the skills to create a seamless user experience.

To validate feasibility and gain early feedback, we'll release a minimum viable version of the guide after milestone 1 (2 months). This will include our existing internal documentation, clarifications on official docs, and examples for key concepts. We'll incorporate suggestions into future full release.

What are the key milestones you need to achieve in order to complete your project successfully?

Milestone 1: Milestone 1 (3 months):

  • Plan and create website infrastructure
  • Import existing internal Aiken documentation and insights
  • Clarify and expand on key parts of official Aiken docs based on our experience
  • Write new guides/tutorials for 5 key Aiken concepts
  • Set up GitHub repo and basic commenting functionality
  • Release initial MVP version of guide for community feedback

Milestone 2: Milestone 2 (2 months):

  • Incorporate community feedback and suggestions into guide
  • Write additional guides, usage examples and best practices (up to 10 topics)
  • Implement full commenting and community contribution functionality
  • Conduct marketing and outreach to raise awareness among Aiken/Cardano devs
  • Release full v1.0 of Living Aiken Guide

Milestone 3: Milestone 3 (2 months):

  • Continue expanding guide content based on our learnings and community input
  • Develop and release interactive tutorials for advanced Aiken topics
  • Promote and grow community usage and contributions
  • Gather feedback and metrics on guide impact and usage
  • Plan for ongoing maintenance and expansion of the guide

Final Milestone: Final Milestone:

  • Release Living Aiken Guide v2.0 with hopefully 30+ topics, advanced tutorials, and robust community layer
  • Complete project close-out report detailing development process, community reception, key metrics and future plans
  • Produce project video highlighting the guide and its value to the Aiken/Cardano ecosystem
  • Transition guide to fully community-maintained mode with our ongoing support

Who is in the project team and what are their roles?

Chadi Nassar - Project Lead and Researcher

Nicolas Caridi - Project Marketer and Content Editor

Fahim Ahamad - Dev Lead and Lead Researcher

Please provide a cost breakdown of the proposed work and resources

Here is our proposed budget breakdown for the 75,000 ADA grant:

  • Development and Technical Writing (65%) - 48,750 ADA
  • 3 Aiken experts to write documentation, create examples, build site features
  • Design and User Experience (15%) - 11,250 ADA
  • Web designer to ensure intuitive, visually engaging user experience
  • Marketing and Community Outreach (10%) - 7,500 ADA
  • Marketing strategist to promote the guide and foster community contributions
  • Project Management and Misc. Expenses (10%) - 7,500 ADA
  • PM to keep project on schedule, coordinate team, misc. expenses

The ongoing development of the Aiken language is a key dependency. While unlikely, if development of Aiken were to cease, it would significantly impact our ability to deliver this project as proposed.

How does the cost of the project represent value for money for the Cardano ecosystem?

This project will deliver tremendous value to the Cardano ecosystem relative to its cost by providing an unparalleled resource for Aiken smart contract developers. With a 75K ADA investment, the Cardano community will gain:

  • A continuously expanding guide with (hopefully) 30+ topics worth of expert Aiken knowledge
  • Countless hours saved from developers having clear, practical documentation and avoiding common pitfalls we've encountered
  • Potential for more secure smart contracts from devs following best practices
  • Faster and easier onboarding of new Aiken/Cardano developers
  • Community collaboration and knowledge sharing around Aiken

No other project is providing this level of practical Aiken knowledge-sharing and interactive guidance. Our team's unique experience positions us to deliver outsized impact for this budget.

By open-sourcing all materials, this will provide ongoing value to Cardano well beyond the 6 month project. It will serve as a key resource to grow the Aiken community, ultimately resulting in more/better dApps and use cases on Cardano. We believe this is an extremely high-leverage investment in the future of Cardano development.

close

Playlist

  • EP2: epoch_length

    Authored by: Darlington Kofa

    3m 24s
    Darlington Kofa
  • EP1: 'd' parameter

    Authored by: Darlington Kofa

    4m 3s
    Darlington Kofa
  • EP3: key_deposit

    Authored by: Darlington Kofa

    3m 48s
    Darlington Kofa
  • EP4: epoch_no

    Authored by: Darlington Kofa

    2m 16s
    Darlington Kofa
  • EP5: max_block_size

    Authored by: Darlington Kofa

    3m 14s
    Darlington Kofa
  • EP6: pool_deposit

    Authored by: Darlington Kofa

    3m 19s
    Darlington Kofa
  • EP7: max_tx_size

    Authored by: Darlington Kofa

    4m 59s
    Darlington Kofa
0:00
/
~0:00