Skip to content

Commit

Permalink
Update 04-good_documentation.Rmd
Browse files Browse the repository at this point in the history
  • Loading branch information
cansavvy authored Jun 26, 2024
1 parent 67a7c66 commit 70836bd
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion 04-good_documentation.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ottrpal::include_slide("https://docs.google.com/presentation/d/1cd434bkLer_CJ04G

## Major components of good documentation

In this chapter we are going to cover the major aspects of a well-documented tool. In the subsequent chapters, we will talk about each of these components in more detail, providing relevant examples and tools.
In this chapter we are going to cover the major aspects of a well-documented tool. In the subsequent chapters, we will talk about each of these components in more detail, providing relevant examples and tools. Others have divided this system into different categories which we have taken inspiration from for what we describe here [@divio].

```{r, fig.alt="The anthropomorphic documentation has 6 major components in this illustration including: The why, getting started, how-to examples, reference guide, code comments, and user feedback.", echo = FALSE}
ottrpal::include_slide("https://docs.google.com/presentation/d/1cd434bkLer_CJ04GzpsZwzeEA9gjc5Ho6QimiHPbyEg/edit#slide=id.gcd0e3791ab_0_23")
Expand Down

0 comments on commit 70836bd

Please sign in to comment.