What is a FLOSS Manual? A guide on creating a FLOSS Manual in line with our community ethos

If you are interested in creating a FLOSS Manual here are some guidelines.

This is a FLOSS Manual

The following represent some of the FLOSS Manuals protocols (please suggest additions and alterations here):

  • Use an open licence such as CC-BY-SA so people can remix, translate, and adapt freely.

  • Aim to make your documentation user focused, active and based on grounded activities, rather than just describing technical features. Manuals which describe how to do something with Free Software are ideal.

  • Allow and document (relatively) simple contribution routes to allow others to add to or improve the manual. Perhaps using Git, pull requests, or shared folders, or WSYISYG editors (e.g. Wordpress)

  • Publish as you wish, but ideally in a way that easy to maintain and migrate: for example using static site tools such as Hugo and MKdocs

  • If possible, provide versions as a downloadable files, epubs, pdfs, and odts. (if not prevented by your publishing system e.g. Wordpress)

  • Link back to the main FLOSS Manuals wesite so readers can still find and adopt older manuals and be aware of the FM community.

  • Please try to avoid intrusive adverts within your content.

Built with Hugo
Theme Stack designed by Jimmy