This manual outlines the work process and practices of the digital communications department of Amnesty International Canada.
Documentation is crucial! Not everyone can afford to spend hours every day cultivating digital literacy. Documentation helps bridge the knowledge gap for non-techincal people.
This documentation was created using Sphinx, which uses .rst files and Python to compile the documentation (its an awesome tool). See amnesty-international-digital-publishing-manual.readthedocs.org for the final product.
See Write the Docs for help getting started with documentation using Sphinx. You will need Git and Python (probably already installed) on your system. You'll need to have basic Git skills, but you don't need to know Python. There are tons of Git tutorials around. This one provides a solid start.
Once you feel comfortable, clone this repository and edit at will!
This documentation was writen by Jackson Couse with help from Greg Clarke
See also, Best Practices, our guide to web development projects.