A template along with its CSS stylesheet to write Job Instruction Breakdown Sheet in Asciidoc.
Documentation is particularly important in FabLab, makerspaces, and hackerspaces, be it for machines usage or project reproduction. So after researching of how to have better instruction manual, I found very few documents: a military manual for job instructors and TWI Job Instruction Breakdown Sheet (See bibliography).
Still, using dedicated software or even advanced text editor can be tedious, that is one of the reason for the existence of Asciidoc. This project aims at providing templates that are:
- easy to write (plain text),
- help to focus on important instructions,
- produce nice looking documentation in several formats.
License is GPL v2, same as asciidoc, (see LICENSE file). It is meant that only the template and style has such license, ie your final document is whatever license you want.
As of 14th May 2015, It requires:
- Asciidoc installation
git clone https://github.com/loic-fejoz/asciidoc-job-breakdown-sheet.gitcd <yourdirectory> && echo "include ../asciidoc-job-breakdown-sheet/rules.mk" >> Makefile- Add your target into your Makefile
make
If you would like to hack on AsciiDoc-Job-Breakdown-Sheet, start by forking the repo on GitHub:
https://github.com/loic-fejoz/asciidoc-job-breakdown-sheet
The best way to contribute is probably one of the following:
- Clone the repo and follow GitHub Workflow.
- Contact Me loic@fejoz.net.
- Visit Me.
What needs to be done:
- Add other examples
- Translate templates to other languages
- Display icons for key points reminder
- Test Epub, and pdf conversion
- Work on all issues
TO BE DONE
- Job Instruction Training within Industry, Bureau of training, War Manpower Commission, Washington D.C., 1944
- Icescream example, TWI
- Lathe Insert, TWI
This is a list of people who have contributed code or ideas to AsciiDoc-Job-Breakdown-Sheet for copyright purposes or whatever.
- Loïc Fejoz loic@fejoz.net https://github.com/loic-fejoz/