Site Search

About searching

Search results

    What are best practices for research software documentation?

    21 June 2019

    What are best practices for research software documentation? Posted by s.aragon on 21 … of the  CW19 speed blog posts series . Good documentation is a fundamental aspect of research software. … we are interested in addressing issues surrounding good documentation of research software and how they can be …

    Read more

    Diátaxis: A systematic framework for technical documentation authoring

    28 November 2023

    Diátaxis: A systematic framework for technical documentation authoring Diátaxis has … how-to guides, explanations and references required for documentation users or those writing technical documentation.  Go to resources …

    Read more

    A concise guide to reproducible MATLAB projects

    06 July 2022

    … project should be to produce a compendium of code, data and documentation that anyone should be able to pick up and run, … Contents Coding style Project organisation Documentation Generating documentation with MATLAB Version control …

    Read more

    CW14 Discussion sesssion 3

    15 April 2014

    … What is the best way to train producers of good software documentation, and why is this important? What are … most important things learnt during this discussion : Documentation depends on how we learn – we need training in pedagogy for documentation courses (pictures/text?) – snapshots that …

    Read more

    To man page... and beyond!

    09 November 2018

    … Raniere Silva, Software Sustainability Institute. Documentation is, alongside version control, … Overleaf, we saw not only releases come out faster but also documentation be richer. If in the early 80s, most of the documentation were available as man pages and books, today …

    Read more

    CW17 Hackday

    25 January 2024

    … leader], Ilektra Christidi; Demo ,  source code , documentation , slides  and video ). … Grace Cox David Mawdsley Andrew Walker Documentation coverage metric Source code  and … Is a source code repository being used? Is there documentation? Are appropriate services and infrastructure …

    Read more

    Previously Discussed Topics

    12 December 2023

    … and grow your community (18 June 2019, CW19 ) Documentation What do we need to consider when … ) What are best practices for research software documentation? What are best practices for research software documentation? (21 June 2019, CW19 ) Funding …

    Read more

    Collaborations Workshop 2019 (CW19)

    06 January 2019

    … The themes of the workshop were interoperability, documentation, training and sustainability. The … our blog post about interoperability at CW19 . Why Documentation 21% of researchers have no training in … ), and 83% of developers learn on their own from official documentation ( Stack Overflow Developer Survey Results …

    Read more

    RTFM is a four-letter word

    27 March 2012

    … provides a great way to avoid addressing issues with your documentation and thereby to avoid taking responsibility to … you from boring activities like support and writing documentation and frees up your time to spend on the fun, … in particular, has been hammered for the quality of its documentation. Consider, again, Grumpy Nerd, “Writing …

    Read more

    How to make your script ready for publication

    06 October 2023

    … the intended results!  This includes the source code, documentation, build scripts, test cases, configuration … or internal urls being shared.  Step 3: Add essential documentation If you want others to use or even … and write down what they need to know. An outdated documentation is the enemy, so keep it short, simple, focus …

    Read more