diff --git a/_slides/software_documentation.md b/_slides/software_documentation.md new file mode 100644 index 0000000..2066432 --- /dev/null +++ b/_slides/software_documentation.md @@ -0,0 +1,29 @@ +--- + +order: 200 + +--- + +## Software Documentation + +
+
+

Be sure that the README file for your code includes all the software versions, packages and libraries necessary to run your code

+
+
+
+ README file with dependencies +
+
+ +
+
+

Your code should also have intelligible inline comments, and that variables and functions have descriptive, human readable names

+
+
+
+ Example of in-line code documentation +
+
diff --git a/assets/img/slides/in-line_comments.png b/assets/img/slides/in-line_comments.png new file mode 100644 index 0000000..43793c7 Binary files /dev/null and b/assets/img/slides/in-line_comments.png differ diff --git a/assets/img/slides/read-me_documentation.png b/assets/img/slides/read-me_documentation.png new file mode 100644 index 0000000..9a3079e Binary files /dev/null and b/assets/img/slides/read-me_documentation.png differ