About GSoD

GSoD supports documentation in open source projects. It seeks to empower open source organizations to understand their documentation needs, to create documentation to fill those needs, to measure the effect and impact of their documentation, and, in the spirit of open source, share what they've learned to help guide other projects. Google Season of Docs seeks to bring more technical writers into open source through funding their work with open source projects and organizations.

About Debian Edu

DebianEdu (aka Skolelinux) is a Debian Pure Blend intended for use in schools. It provides an easy installation for a main server, with most of the services pre-configured out-of-the-box. Diskless clients can boot from the main server via network, user authentication is centralized, and home directories are also stored on the main server. Thus, it simplifies a lot the installation, configuration and maintenance of a school network. Besides, Debian Edu also maintains packages of educational software, categorized by subject and by level, which can be easily installed on any Debian (or Debian based) system.

Skolelinux and DebianEdu started as independent projects on 2001, but in 2003 they joined forces together and became a standard part of Debian. This system has been used mainly on Norwegian and German schools, but also in other countries. Its docs have translations on: German, French, Italian, Spanish, Danish, Japanese, Norwegian, Dutch, Swedish, Portuguese, Chinese, etc. This shows the wide interest and contributions that this project had over the years.

The project objectives, since the very beginning, have been:

For a quick introduction to Debian Edu see: Getting started with DebianEdu (video)

The problem

The current documentation of Debian Edu is a big manual that includes many details about the installation and configuration. This is useful to system administrators, but not so useful to normal non-technical users (teachers and students). There are actually two small sections in this manual dedicated to students and teachers, but they are almost empty. So, the documentation for non-technical users is almost missing.

We also received feedback recently from various teachers, that the Debian Edu manual is too complex and too technical for finding teacher related help.

For making Debian Edu a true competitor to proprietary solutions, we see a definite need of providing a documentation that would allow ordinary users (teachers and students) to understand and use Debian Edu easily. This also aligns with the main objectives of Debian Edu.

Project ideas

Documentation for non-technical users

A user documentation, that explains Debian Edu for non-technical users (teachers and students), and shows how to use it.

It should explain things in a layman's language, trying to avoid complex technical terminology. It should be good-looking and visually attractive. It should also be possible to produce nice PDF and EPUB versions of the docs. It should support versioning (having different versions of the docs for different releases of Debian Edu), and it should also support translation to different languages.

Video tutorials

Some video tutorials (screen recordings) that explain how to use Debian Edu could be very useful. As they say, a picture is worth thousands of words, and a video tutorial is worth thousands of doc pages.

New website

A new website for the project would be nice. Currently, the main homepage of the project is on the wiki: DebianEdu. The new website should be good looking and attractive (using some static site generator tools like Jekyll, Hugo, etc.). The information from the wiki pages should not just be migrated to the new homepage, but also updated with the latest status and info about the project, and maybe reorganized as well.

About technical writers

Technical writers are expected to have these skills:

We may also need a couple of volunteers to make an initial review of the new docs, providing any feedback.

How to contact

For any questions or discussions, please write to the mailing list including GSoD in the subject.