In this article, we explore how we can provide a user guide for software projects that grow beyond their original scope so that a 1-page readme file may not be sufficient anymore. We will look at a package called Sphinx that helps us write a user guide by adding searching, navigation, and a table of …
How to write a user guide to document your CFD code Read More »
In this artile, we will look at how to structure a 1-page readme file that you must provide for each and every software project you embark on from now on. Be it a short library or a complex code base, you owe it to your users (and yourself) to provide a minimum set of instructions …
How to write a 1-page readme file to document your code Read More »
In this article, we will explore the three main components that makeup code documentation. We will explore why providing documentation is important and how it improves the chance that others will start using your code. We also look at situations where writing documentation for the sake of it may lead to pointless documentation and this …
Documenting code; why bother and how to do it right Read More »