3 ms·
Design the data format (API) first, then the user interface later. You have the cart in front of the horse. Rather than decide how it looks and works, decide
by zdw 16y ago
Design the data format (API) first, then the user interface later. You have the cart in front of the horse.
Rather than decide how it looks and works, decide how you want the data structured then come up with a format to represent it. This sounds like unstructured to minimally structured document centric data - something like a Markdown with additional tagging or an XML format would probably be ideal.
This way, eventually when your design changes or someone wants to shift the data into another format (say mobile use, or transformed into LaTeX for publication), it's a matter of writing a fairly simple converter, rather than trying to scrape the site or do other PITA stuff.
- possibilistic 16y agoMarkdown sounds right. I don't see open protocols being published in print though. Especially not if they're collaboratively edited in any way.
- Cixelyn 16y agoI think it would be even better if the protocols were stored in some sort of machine parse-able format rather than just human readable text. This solves two problems a) the big problem of reproducibility in fields like biology, and b) if it's machine-readable, you can just toss the file onto a robot and have the whole procedure done for you. Check out Biocoder for an example of a language for describing protocols: http://research.microsoft.com/en-us/um/india/projects/biocoder/ http://research.microsoft.com/en-us/um/india/projects/biocod... Format conversion and outputting versions for publication also follow quite easily once a strict protocol language is defined.