Skip to content

Commit

Permalink
Update 01-intro.Rmd with code chunk names
Browse files Browse the repository at this point in the history
Updated the code chunk names to point out topics covered, learning objectives, and for individuals who slides
  • Loading branch information
kweav authored Dec 10, 2024
1 parent 6461483 commit effbfde
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions 01-intro.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@ Increasing the usability and quality of documentation for a tool is not only hel

The course is intended for cancer informatics tool developers, particularly those creating tools as a part of the [Informatics Technology Cancer Research](https://itcr.cancer.gov/informatics-tools).

```{r, fig.alt = "For individuals whom: Create informatics tools, want to learn how to apply user experience design principles to their tools and want to increase the quality of their documentation", echo = FALSE}
```{r for_individuals_who, fig.alt = "For individuals whom: Create informatics tools, want to learn how to apply user experience design principles to their tools and want to increase the quality of their documentation", echo = FALSE}
ottrpal::include_slide("https://docs.google.com/presentation/d/1PH9_KlLVggYpNJI0fgvcIcft2vDtGA_mlCqKFA8gnAg/edit#slide=id.g2def1a354ad_0_0")
```

## Topics covered:

```{r, fig.alt="Concepts discussed in Documentation and Usability course:Apply usability research concepts, Create user friendly guides, Document code clearly, Obtain helpful user feedback", out.width = "100%", echo = FALSE}
```{r topics_covered, fig.alt="Concepts discussed in Documentation and Usability course:Apply usability research concepts, Create user friendly guides, Document code clearly, Obtain helpful user feedback", out.width = "100%", echo = FALSE}
ottrpal::include_slide("https://docs.google.com/presentation/d/1PH9_KlLVggYpNJI0fgvcIcft2vDtGA_mlCqKFA8gnAg/edit#slide=id.g2def1a354ad_0_6")
```

## Curriculum

```{r, fig.alt = "This course will demonstrate how to: Understanding why usability and documentation is vital, Identifying your user community, Building documentation and tutorials to maximize the usability of developed tools, Obtaining feedback from your users", echo = FALSE}
```{r learning_objectives, fig.alt = "This course will demonstrate how to: Understanding why usability and documentation is vital, Identifying your user community, Building documentation and tutorials to maximize the usability of developed tools, Obtaining feedback from your users", echo = FALSE}
ottrpal::include_slide("https://docs.google.com/presentation/d/1PH9_KlLVggYpNJI0fgvcIcft2vDtGA_mlCqKFA8gnAg/edit#slide=id.gd422c5de97_0_10")
```

Expand Down

0 comments on commit effbfde

Please sign in to comment.