Difference between revisions of "Nydus Documentation standards"
From Nydus Network
(Created page with "We strongly advise everyone who is involved in a project or wants to start one, to document next to everything that you do. That includes protocols for methods, materials, you...") |
|||
| Line 1: | Line 1: | ||
We strongly advise everyone who is involved in a project or wants to start one, to document next to everything that you do. That includes protocols for methods, materials, your finances, something like a member list, tasks that got distributed, results, milestones, problems and so on. While we can offer just advice and suggestions, the way you document and the tools you use are of course entirely up to you. However, if you want your project to be included in the Knowledge base of the Nydus, you have to adhere to the standards and formats we use here. | We strongly advise everyone who is involved in a project or wants to start one, to document next to everything that you do. That includes protocols for methods, materials, your finances, something like a member list, tasks that got distributed, results, milestones, problems and so on. While we can offer just advice and suggestions, the way you document and the tools you use are of course entirely up to you. However, if you want your project to be included in the Knowledge base of the Nydus, you have to adhere to the standards and formats we use here. | ||
| − | = | + | =General Advice= |
*General Outline of the projet (What is the aim of the project, what do you want to do, which people could you acquire, do you have a timetable or plan for your experiments/working steps?) | *General Outline of the projet (What is the aim of the project, what do you want to do, which people could you acquire, do you have a timetable or plan for your experiments/working steps?) | ||
| Line 8: | Line 8: | ||
*Milestones/Results (Agree on a certain standard how to document achieved milestones or maybe trouble shooting if you run into problems. But also set a certain standard on how you want to document your results) | *Milestones/Results (Agree on a certain standard how to document achieved milestones or maybe trouble shooting if you run into problems. But also set a certain standard on how you want to document your results) | ||
| − | =Example= | + | =Nydus Documentation Example= |
Latest revision as of 10:19, 27 July 2018
We strongly advise everyone who is involved in a project or wants to start one, to document next to everything that you do. That includes protocols for methods, materials, your finances, something like a member list, tasks that got distributed, results, milestones, problems and so on. While we can offer just advice and suggestions, the way you document and the tools you use are of course entirely up to you. However, if you want your project to be included in the Knowledge base of the Nydus, you have to adhere to the standards and formats we use here.
General Advice
- General Outline of the projet (What is the aim of the project, what do you want to do, which people could you acquire, do you have a timetable or plan for your experiments/working steps?)
- Memberlist (maybe already with assigned roles or tasks, e.g. Person X is responsible for task Y or for financing, etc.)
- Finances (Include all necessary costs and your sources of income here. This is especially needed and useful if you don't finance the project yourself and have to hand in receipts for example. Another advice: Make copies of everything, 2 or maybe even 3 times, so that in legal cases you have something to provide)
- Milestones/Results (Agree on a certain standard how to document achieved milestones or maybe trouble shooting if you run into problems. But also set a certain standard on how you want to document your results)
