Add links

FAIR2-for-research-software · Oct 14, 2024 · fc7eea3 · fc7eea3
1 parent 7021b67
commit fc7eea3
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/episodes/readmes.md b/episodes/readmes.md
@@ -460,4 +460,5 @@ Use diagrams and screenshots for clarity.
 For more information about writing basic software documentation, please review the following materials:
 
 - Raphael Pierzina [Hi, my name is README!](https://www.writethedocs.org/videos/eu/2017/hi-my-name-is-readme-raphael-pierzina/)
+- Kira Oakley [The Art of README](https://github.com/hackergrrl/art-of-readme/blob/master/README.md)
 - Aleksandra Pawlik [Five top tips on documentation](https://www.software.ac.uk/guide/five-top-tips-documentation)
diff --git a/learners/reference.md b/learners/reference.md
@@ -61,3 +61,5 @@ Linter
 
 - Write the Docs, [A beginner’s guide to writing documentation](https://www.writethedocs.org/guide/writing/beginners-guide-to-docs/)
 - S. Druskat and S. Harriet, *Software Sustainability Institute* [What are best practices for research software documentation?](https://www.software.ac.uk/blog/what-are-best-practices-research-software-documentation)
+- [_Diataxis_](https://diataxis.fr/) A systematic approach to technical documentation authoring.
+- Code Refinery [How to document your research software](https://coderefinery.github.io/documentation/)