Table of Contents
Construction Guide Template
Introduction
This page explains how to build a construction guide in Filmlabs' wiki.
Quick overview
- Difficulty : Easy
- Duration: 10 minutes to 10 days (depending on the construction guide you're about to build)
- Cost :Time & Effort
Skills needed
Knowing how to publish on FilmLabs Wiki.
Material needed
- Computer
- Internet connection
- Pictures / screenshots
Step by step
Step 1 - Connect to FilmLabs' wiki
In order to contribute, we'll have to log in the wiki, since it's not like Wikipedia.
- Connect the computer to the Internet
- If you don't already have an account, ask for one to the wikimaster
- <todo @maxime @pierre>Gather wikimasters addresses</todo>
- If you didn't already read the how to publish article, please do.
Step 2 - Create a new page with the right template
To be sure to follow this template, please be sure to comply to the instructions below.
- Create a new page (with an English title, for translation purposes)
- Copy/paste the content of the Construction guide template skeleton in your new page
Step 3 - Do your stuff
You can start writing the documentation ! As writing is a long process, you may want to focus on going with the flow and come back to some parts later (for example for giving more details) : for that, you can add “TO DO notes”, with the following code block :
<todo @someone>Add some details to step 3</todo>
… replacing @someone with your username (or the username of the person that is supposed to do it ;~), and then find all the TO DO's here. For example :
<todo @someone>Add some details to step 3</todo>
Substeps and other stuff
You can add video if needed !
If you add new content, please upload it on free/open source platform, like Peertube for example on Domaine Public's instance, as the whole filmlabs.org website & wiki are hosted by Domaine Public (Brussels based web hosts for non-profits)
- TO DO → show how to find the useful link for
- from youtube, you can select excerpt → https://www.dokuwiki.org/plugin:vshare
Conclusion
Writing a nice construction guide is not that hard, and it's worth the effort, don't you think ?