Presentation Open Access

Continuous Documentation for Users, Developers and Maintainers

Frust, Tobias


MARC21 XML Export

<?xml version='1.0' encoding='UTF-8'?>
<record xmlns="http://www.loc.gov/MARC21/slim">
  <leader>00000nam##2200000uu#4500</leader>
  <datafield tag="041" ind1=" " ind2=" ">
    <subfield code="a">eng</subfield>
  </datafield>
  <datafield tag="653" ind1=" " ind2=" ">
    <subfield code="a">Documentation</subfield>
  </datafield>
  <datafield tag="653" ind1=" " ind2=" ">
    <subfield code="a">Software</subfield>
  </datafield>
  <datafield tag="653" ind1=" " ind2=" ">
    <subfield code="a">Best Practices</subfield>
  </datafield>
  <datafield tag="653" ind1=" " ind2=" ">
    <subfield code="a">Sustainability</subfield>
  </datafield>
  <datafield tag="653" ind1=" " ind2=" ">
    <subfield code="a">Sustainable</subfield>
  </datafield>
  <datafield tag="653" ind1=" " ind2=" ">
    <subfield code="a">Version Control</subfield>
  </datafield>
  <controlfield tag="005">20200120165417.0</controlfield>
  <controlfield tag="001">3247324</controlfield>
  <datafield tag="711" ind1=" " ind2=" ">
    <subfield code="d">12-14 June 2019</subfield>
    <subfield code="g">PASC19</subfield>
    <subfield code="a">Platform for Advanced Scientific Computing Conference 2019</subfield>
    <subfield code="c">Zurich, Switzerland</subfield>
    <subfield code="n">MS55 - Towards Sustainable Scientific Software through Better Engineering, Development, Documentation, Publication and Curation</subfield>
  </datafield>
  <datafield tag="856" ind1="4" ind2=" ">
    <subfield code="s">1982914</subfield>
    <subfield code="z">md5:a40c35327604276ec81459711db0702f</subfield>
    <subfield code="u">https://zenodo.org/record/3247324/files/software-documentation.pdf</subfield>
  </datafield>
  <datafield tag="856" ind1="4" ind2=" ">
    <subfield code="s">2295859</subfield>
    <subfield code="z">md5:69f81c5de97e87005d01b77532b7ea5d</subfield>
    <subfield code="u">https://zenodo.org/record/3247324/files/software-documentation.pptx</subfield>
  </datafield>
  <datafield tag="542" ind1=" " ind2=" ">
    <subfield code="l">open</subfield>
  </datafield>
  <datafield tag="856" ind1="4" ind2=" ">
    <subfield code="y">Conference website</subfield>
    <subfield code="u">https://pasc19.pasc-conference.org/</subfield>
  </datafield>
  <datafield tag="260" ind1=" " ind2=" ">
    <subfield code="c">2019-06-17</subfield>
  </datafield>
  <datafield tag="909" ind1="C" ind2="O">
    <subfield code="p">openaire</subfield>
    <subfield code="o">oai:zenodo.org:3247324</subfield>
  </datafield>
  <datafield tag="100" ind1=" " ind2=" ">
    <subfield code="u">Helmholtz-Zentrum Dresden-Rossendorf</subfield>
    <subfield code="0">(orcid)0000-0002-5590-7473</subfield>
    <subfield code="a">Frust, Tobias</subfield>
  </datafield>
  <datafield tag="245" ind1=" " ind2=" ">
    <subfield code="a">Continuous Documentation for Users, Developers and Maintainers</subfield>
  </datafield>
  <datafield tag="540" ind1=" " ind2=" ">
    <subfield code="u">https://creativecommons.org/licenses/by/4.0/legalcode</subfield>
    <subfield code="a">Creative Commons Attribution 4.0 International</subfield>
  </datafield>
  <datafield tag="650" ind1="1" ind2="7">
    <subfield code="a">cc-by</subfield>
    <subfield code="2">opendefinition.org</subfield>
  </datafield>
  <datafield tag="520" ind1=" " ind2=" ">
    <subfield code="a">&lt;p&gt;This talk covers the often neglected and &amp;ldquo;hated&amp;rdquo; aspect of software documentation that is indispensable in a sustainable research software development process. A good, up-to-date and easily accessible software documentation lays the foundation for broader usage and collaboration. Software documentation usually covers three different components: user documentation, instructions how to modify and contribute to the software and a low-level API documentation. When starting developing a new research software, the documentation should be considered from the very beginning. Maintaining an up-to-date software documentation with good coverage in an exascale ready scientific software stack is only achievable, if the contribution process clearly includes a check for documentation adding or updates. This check can only be automated partially and usually requires a manual review process. All contributions must be made with the understanding, that documentation is a key aspect of any contribution. Things get never cleaned up later. Recurrent tasks should be automated wherever possible to reduce the impact of manual errors, e.g. the deployment of software documentation. This talk provides a set of best practices for software documentation in science combined with concrete examples from real-world scientific software solutions.&lt;/p&gt;</subfield>
  </datafield>
  <datafield tag="773" ind1=" " ind2=" ">
    <subfield code="n">doi</subfield>
    <subfield code="i">isVersionOf</subfield>
    <subfield code="a">10.5281/zenodo.3247323</subfield>
  </datafield>
  <datafield tag="024" ind1=" " ind2=" ">
    <subfield code="a">10.5281/zenodo.3247324</subfield>
    <subfield code="2">doi</subfield>
  </datafield>
  <datafield tag="980" ind1=" " ind2=" ">
    <subfield code="a">presentation</subfield>
  </datafield>
</record>
376
53
views
downloads
All versions This version
Views 376376
Downloads 5353
Data volume 106.3 MB106.3 MB
Unique views 363363
Unique downloads 4141

Share

Cite as