How to document computational research projects
1 like107 views
These slides are from an internal meeting at pharmb.io where we discussed ways to improve documentation of our internal computational research projects. The winning solutions turns out to be markdown files, versioned with git. The slides explains a little bit about why.
How to document computational research projects
- 1. How to do project documentation: An idea
- 2. Project Management (Trello, Jira ...) != Project Documentation (Planning docs, Meeting notes, Links to data & code )
- 4. Name to enable search
- 6. Very easily convert to TeX (with pandoc)
- 7. Feature comparison Word files Google Docs Latex Markdown Local Editing Yes No Yes Yes On-line editing No Yes So so ... Yes Git history Not really No Yes Yes Conv to TeX So so ... So so ... Yes Yes Fast to type Yes Yes No Yes