Google Season of Docs project ideas

Kiwix-hotspot

Write our IKEA manual.

Context:

Kiwix-Hotspot runs on cheap Raspberry Pi (RPi) devices and is a small, inexpensive hotspot that people can take around the world. End users can connect to it without having to worry about downloading content or even installing an app on their device. There are already more than a million students using these devices (mostly in Africa and South America), and that number is set to expand exponentially over the next couple of years.

Raspberry Pi works with the Raspbian Operating System, and creating the hotspot configuration does take a bit of command line work. In order to simplify everyone’s life, we built a hotspot-installer with a user interface that will run on any desktop computer: simply pick the files you want, click “install” and let it do the work – you will end up with a large image (.img) that can then be flashed onto a microSD card and inserted into the RPi.

This remains however a bit tedious and labor-intensive for a poor personal computer, so we adapted the installer to make it run on our servers. Users can simply punch a few buttons on a web interface, and get a download link a couple of hours later.

Needs:

Most of our users are not fluent English speakers. Yet there is no way we can translate our manual into the 10-odd most used languages our users work with. We therefore need something simple and visually compelling.

Specifically:

  • Improve (simplify) the desktop installer’s user manual, which currently stands as a 20 pages-long Word document (right, eh?);
  • Ideally, you should be able to turn this into a visual scenario;
  • Develop a similar user manual (written & graphic) for the online installer.
  • Work with other team members to highlight areas that you feel could do with improvement most, plan them and then implement.

Want to join?

Then think hard about what you want to do, and go to the Google Season of Docs website until 8 June, 2020, to submit your projects!

Do you have questions?

Feel free to reach out via Twitter (DM open) or email (info -at- kiwix.org

Kiwix-serve

Make sure that people are able to steal this software.

Context:

Kiwix-serve is a http daemon that basically serves zim files to clients. A simple online example is https://library.kiwix.org. Obviously, in the context of Kiwix the implementation is much more interesting for organisations that have no to little internet access: Kiwix-serve is thus being used in Universities, Prisons, or more exotic settings like a Whatsapp service in Zimbabwe.

Needs:

We have a basic documentation on our wiki, but it is fairly minimal. Because this is an open-source software, we want as many people as possible to be able to deploy and use Kiwix-serve, preferably without us having to explain how this works.

Specifically:

  • Revamp the description page (so as to move it from our wiki to our main website);
  • Create an easy-to-follow documentation that can eventually be exported as a PDF.

Use Case Stories

Kiwix is awesome. Kiwix users are awesomer.

Context:

Kiwix is free to use, re-use and distribute. Some organizations we partner with are doing just that, using Kiwix for their own purpose in settings we had not expected – be it on remote islands, mountains or prisons

Needs:

Our goal is to showcase the many possibilities and impact that Kiwix can have through these very human stories, and set up a process by which we know what to ask of future partners so as to quickly bring new user stories to attention.

Select 5-10 partners and elaborate stories that cover:

  • context (region, challenges…)
  • grantee org (background, structure…)
  • project timeline
  • results and impact

Format as a report with illustrations/graphs.

     

    Audience Reach and User Experience

    Every journey starts with the first step you will design.

    Context:

    Kiwix and OpenZIM are two projects that sustain the whole offline ecosystem of more than 50 Github repositories. Some are maintained professionnally, some by volunteers.

    Needs:

    In order to maintain consistency and improve contributor onboarding, the first step should be to know what our strong and weak points are. 

    Specifically:

    Design and conduct a survey for technical documentation users on Kiwix and OpenZIM repositories. Use findings to recommend improvements and to design and draft a set of technical documents based on user research.