Documentation task list

[glopesdev]

DOCUMENTATION

Svenja will present the full and detailed plan for documentation/website soon, Here I just want to give an overview so people can have an idea of how much involvement we are hoping to have from each team member. We would need help from everyone . I have tentatively put some names here and there of who I think knows the relevant information for each step, but please feel free to edit. @snierwetberg will be overseeing and working on all aspects of the docs/website, so I haven’t written her name every time.

• Breakdown documentation tasks for mechatronic documentation #53
• Breakdown documentation tasks for wiring diagram #54
• Implementation of modular bonsai
• Breakdown documentation tasks for module workflows for how to, glossary #55
• Breakdown python API documentation for modules, how to, glossary #56
• Breakdown analysis for modules, how to, glossary from data API #57
• Breakdown analysis for modules, how to, glossary for DataJoint #58
• How to experiments:
  • How to start an experiment: all the steps required to run an experiment front to end (check list). @lorycalca , @jkbhagatio , @aspaNeuro

[snierwetberg]

Outcome of meeting on Tues 29th

• agreed on general structure for workflow documentation for all modules (See above).
• Tom and André will start with Feeder Doc (since it's one of the more complex ones)
• Jai and me to compile a list of all modules that need documenting, and select those that need to be documented with a greater level of detail
• Open question: where will the "Soft Modules" go? Some, like tracking, might deserve their own category in the "Modules" section. Other smaller ones might go into the Glossary/Reference section.