Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

Chimoney Write-a-Thon Writing Challenge

Welcome to the 1st edition of the WriteTech Hub Write-A-Thon Writing Challenge, in partnership with Chimoney and DevRel Community Africa.

This challenge empowers aspiring and experienced tech writers to build real-world writing experience by documenting the Chimoney API through practical, developer-focused content.

🗓️ Important Dates

Date Milestone
July 16 Challenge Kickoff call (with Chimoney + WTH)
July 22 Mid-challenge AMA session
July 31 Submission deadline
August 7 Winners announced

Rewards

  • $35 USD cash reward for top 3 contributors
  • Top 3 contributors Featured on WriteTech Hub + Chimoney blogs and social media
  • Community recognition and networking opportunities

How to participate

Step 1: Register and join the community

Step 2: Choose your API endpoint

Pick ONE Chimoney API endpoint to focus on:

Step 3: Create these three deliverables

You’ll create three separate documents (in Markdown) to showcase your technical writing skills:

  1. Use case article (use-case.md)

    • Describe a real-world scenario where your chosen API endpoint is useful
    • Example: gig worker payouts, cross-border remittances
  2. Tutorial guide (tutorial.md)

    • Step-by-step guide showing how to use the API endpoint in code
    • Include sample requests, responses, and clear explanations
  3. Setup guide (setup.md)

    • Guide readers through authentication and environment setup
    • Ensure they can successfully call the API by the end

Folder structure

Your submission should be placed inside the submissions/ folder using this format:

submissions/
└── [endpoint]-[slackhandle]/
├── use-case.md
├── tutorial.md
└── setup.md

Example:

submissions/
└── payout-zaycodes/
├── use-case.md
├── tutorial.md
└── setup.md

Submission steps

Step 4: Submit your work on GitHub

  1. Fork this repository
  2. Create a new branch:
    Format: [endpoint]-[your-slackhandle]
    Example: wallet-funmiwrites
  3. Add your folder and three Markdown files inside submissions/
  4. Open a Pull Request to the main branch
  5. Fill out the Pull Request template and tag the following reviewers: @Phyleria, @adebayoileri

Step 6: Stay tuned

  • All updates, reviews, and winner announcements will be shared via the community forums.

Challenge docs & guidelines

To help you succeed:

Useful resources

Tips for success

  • Quality > Quantity: Focus on clarity, depth, and usefulness
  • Real Use Cases: Anchor your writing in practical examples
  • Beginner-Friendly: Assume readers are new to Chimoney
  • Engage the Community: Use Slack to ask questions and get feedback

Ready to showcase your technical writing skills and contribute to Africa's growing tech ecosystem? Join us in the Write-A-Thon Writing Challenge!