{"id":294,"date":"2012-06-17T07:59:17","date_gmt":"2012-06-17T07:59:17","guid":{"rendered":"http:\/\/ahay.org\/blog\/?p=294"},"modified":"2015-09-03T00:20:05","modified_gmt":"2015-09-03T00:20:05","slug":"why-does-madagascar-have-such-poor-documentation","status":"publish","type":"post","link":"https:\/\/ahay.org\/blog\/2012\/06\/17\/why-does-madagascar-have-such-poor-documentation\/","title":{"rendered":"Why does Madagascar have such poor documentation?"},"content":{"rendered":"<p>Most likely, the person asking this question does not know where to look for documentation. With 6 <a href=\"\/wiki\/Conferences#Featured_events\">schools<\/a>, 300 <a href=\"\/blog\/\">blog posts<\/a>, 80 <a href=\"\/wiki\/Main_Page\">wiki pages<\/a>, <a href=\"\/RSF\/book\/rsf\/\">500-page manual<\/a> and <a href=\"\/RSF\/book\/tutorial\/\">50-page<\/a> <a href=\"\/wiki\/Tutorial\">tutorial<\/a>, there is plenty of information for somebody willing to learn about <strong>Madagascar<\/strong> or to understand how it works. <\/p>\n<p><a href=\"\/wiki\/Reproducible_Documents\">Reproducible papers and books<\/a> link scientific descriptions of different algorithms with examples of their usage and thus represent the best kind of documentation scientific software may have. On the last count, there were more than 500 <a href=\"\/wiki\/SCons\">computational recipes<\/a> (<tt>SConstruct<\/tt> files) and more than 5,000 <a href=\"\/wiki\/Download#Reproducible_figures\">reproducible figures<\/a>. Reproducibility means: we provide reproducible examples of using a particular program but we do not guarantee that the program will work properly with a different choice of parameters or with different input data. With time, the ecosystem evolves. Some programs are getting used more often and, as a result, are getting better debugged and more thoroughly documented. <\/p>\n<p><strong>Madagascar<\/strong> has a low barrier for authors to start <a href=\"\/wiki\/Contributing_new_programs_to_Madagascar\">contributing their work<\/a>. When some of the newly contributed programs and examples are not sufficiently well documented, documentation becomes a process of communication between authors and users. Engaging users as active participants in this process will help us make it more efficient.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Most likely, the person asking this question does not know where to look for documentation. With 6 schools, 300 blog posts, 80 wiki pages, 500-page manual and 50-page tutorial, there is plenty of information for somebody willing to learn about Madagascar or to understand how it works. Reproducible papers and books link scientific descriptions of [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_import_markdown_pro_load_document_selector":0,"_import_markdown_pro_submit_text_textarea":"","activitypub_content_warning":"","activitypub_content_visibility":"local","activitypub_max_image_attachments":4,"activitypub_interaction_policy_quote":"","footnotes":""},"categories":[4],"tags":[],"class_list":["post-294","post","type-post","status-publish","format-standard","hentry","category-faq"],"_links":{"self":[{"href":"https:\/\/ahay.org\/blog\/wp-json\/wp\/v2\/posts\/294","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ahay.org\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ahay.org\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ahay.org\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ahay.org\/blog\/wp-json\/wp\/v2\/comments?post=294"}],"version-history":[{"count":3,"href":"https:\/\/ahay.org\/blog\/wp-json\/wp\/v2\/posts\/294\/revisions"}],"predecessor-version":[{"id":20191,"href":"https:\/\/ahay.org\/blog\/wp-json\/wp\/v2\/posts\/294\/revisions\/20191"}],"wp:attachment":[{"href":"https:\/\/ahay.org\/blog\/wp-json\/wp\/v2\/media?parent=294"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ahay.org\/blog\/wp-json\/wp\/v2\/categories?post=294"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ahay.org\/blog\/wp-json\/wp\/v2\/tags?post=294"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}