At the Berlin meeting yesterday we decided on a real-time, etherpad-based documentation strategy for Berlin. I will create a tutorial showing team leaders / documentation people in other cities how they can adapt our framework for their own local challenges.
NOTE: There are two types of documentation for this event - one is more communication/documentation - the storytelling aspect. This is photos, videos, blogposts, social media etc. This is to inform, entertain and ‘spread the word’ - it is more of a one-way medium, mostly designed to be ‘consumed’. I’m preparing a separate plan for this, I’ll post an update soon.
But what I’m talking about here is open source documentation - we’re trying to create the ‘source code’ or recipe for our challenges, to allow others to understand them, collaborate on them, replicate them, and to enable the projects to live on longer than this weekend.
For Berlin at least, I will set up an etherpad for each challenge using the naming structure
(using the name of the challenge as stated in the forum)
I will also create a folder for each challenge within the ownCloud, in
Links between the cloud folder, etherpad and forum will be prominently displayed at the top of the page or folder so that the user knows where to find, post and upload information related to their challenge.
Here’s my first draft, it’s a wiki, feel free to edit and improve (ping @matthias @Lars2i @eliana @Timm @unteem )
When people first go to the etherpad for their challenge, they will see this text:
(you can see it in etherpad here)
[LINK TO CHALLENGE IN THE FORUM]
[UPLOAD DOCUMENTS, FILES AND PHOTOS TO THE CHALLENGE FOLDER]
Unless otherwise noted, all content in this document is under copyright to the people listed under ‘Participants’ and published under the open source Creative Commons Attribution-ShareAlike license.
By filling in this documentation template, you make it easier for other people to understand your challenge, collaborate with you, and learn from your discoveries, your successes and failures. For your challenge to live on after OSCEdays 2015, you need to record what happens!
AIM / IDEA:
What is the aim of this challenge? What do you want to achieve / produce?
Who is taking part in the challenge?
Do you have a smartphone or camera? Please take photos at various stages of your challenge’s development – we want to see WHAT steps you took, HOW the project works and WHO was working on the project. Of course you can take photos of the finished result, but we also want to see the process, the experiments and the mistakes along the way! Please upload your photos to your challenge folder. [LINK]
TECHNOLOGIES, PARTS AND TOOLS:
What parts or resources would somebody need to replicate your work? Tools, parts, a computer, software, electricity…
How can somebody replicate your work? What processes/steps/activites are involved?
This is like a recipe: 22.214.171.124.5…
WHAT DIDN’T WORK?
What processes, ideas and attempts did not work so well? What mistakes did you make, what ideas did you have to abandon?
What solutions and ideas do you feel happy with? What developments seem most positive? What do you want to work on further?
OPTIONAL other categories for documentation (we would love to see this documented as well!)
[BACKGROUND – what is the context of this challenge, its target group and participants?]
[COLLABORATION – what other people & teams have you worked with, or would you like to work with on this challenge?]
[TARGET GROUPS – who is this challenge for? Whose problem does it attempt to solve? Who will be the ‘user’ of this solution?]
[MEASUREABLE OBJECTIVES – what do you want to achieve with this project?]
[SUCCESS CRITERIA – what would you see as evidence of the ‘success’ of this project – in the short-term (months), and in the long-term (years)?]
[RESOURCES – what social, financial, material or other resources do you need / do you have available for this project?]
[RELATED PROJECTS – what other projects are similar to yours, or linked / required for / dependent on yours?]