generated from jhudsl/OTTR_Template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bd0b294
commit 8cf20fb
Showing
29 changed files
with
112 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 1 Introduction | ||
|
||
{type: iframe, title:1 Introduction, width:800, height:600, poster:resources/chapt_screen_images/introduction.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/introduction.html) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 10 Other helpful features | ||
|
||
{type: iframe, title:10 Other helpful features, width:800, height:600, poster:resources/chapt_screen_images/other-helpful-features.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/other-helpful-features.html) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 11 How to keep your documentation up to date | ||
|
||
{type: iframe, title:11 How to keep your documentation up to date, width:800, height:600, poster:resources/chapt_screen_images/how-to-keep-your-documentation-up-to-date.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/how-to-keep-your-documentation-up-to-date.html) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 2 Documentation: Why it’s worth the effort! | ||
|
||
{type: iframe, title:2 Documentation: Why it’s worth the effort!, width:800, height:600, poster:resources/chapt_screen_images/documentation-why-its-worth-the-effort.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/documentation-why-its-worth-the-effort.html) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 3 Lessons we should borrow from user designers | ||
|
||
{type: iframe, title:3 Lessons we should borrow from user designers, width:800, height:600, poster:resources/chapt_screen_images/lessons-we-should-borrow-from-user-designers.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/lessons-we-should-borrow-from-user-designers.html) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 4 What does good documentation look like? | ||
|
||
{type: iframe, title:4 What does good documentation look like?, width:800, height:600, poster:resources/chapt_screen_images/what-does-good-documentation-look-like.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/what-does-good-documentation-look-like.html) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 5 Creating a smooth getting started section | ||
|
||
{type: iframe, title:5 Creating a smooth getting started section, width:800, height:600, poster:resources/chapt_screen_images/creating-a-smooth-getting-started-section.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/creating-a-smooth-getting-started-section.html) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 6 Creating helpful how-to examples | ||
|
||
{type: iframe, title:6 Creating helpful how-to examples, width:800, height:600, poster:resources/chapt_screen_images/creating-helpful-how-to-examples.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/creating-helpful-how-to-examples.html) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 7 Creating handy reference guides | ||
|
||
{type: iframe, title:7 Creating handy reference guides, width:800, height:600, poster:resources/chapt_screen_images/creating-handy-reference-guides.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/creating-handy-reference-guides.html) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 8 Creating clarifying code comments | ||
|
||
{type: iframe, title:8 Creating clarifying code comments, width:800, height:600, poster:resources/chapt_screen_images/creating-clarifying-code-comments.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/creating-clarifying-code-comments.html) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 9 Obtaining user feedback | ||
|
||
{type: iframe, title:9 Obtaining user feedback, width:800, height:600, poster:resources/chapt_screen_images/obtaining-user-feedback.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/obtaining-user-feedback.html) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# About the Authors | ||
|
||
{type: iframe, title:About the Authors, width:800, height:600, poster:resources/chapt_screen_images/about-the-authors.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/about-the-authors.html) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# About this course | ||
|
||
{type: iframe, title:About this course, width:800, height:600, poster:resources/chapt_screen_images/index.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/index.html) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
1-Introduction.md | ||
2-Documentation:-Why-it’s-worth-the-effort!.md | ||
3-Lessons-we-should-borrow-from-user-designers.md | ||
4-What-does-good-documentation-look-like?.md | ||
5-Creating-a-smooth-getting-started-section.md | ||
6-Creating-helpful-how-to-examples.md | ||
7-Creating-handy-reference-guides.md | ||
8-Creating-clarifying-code-comments.md | ||
9-Obtaining-user-feedback.md | ||
10-Other-helpful-features.md | ||
11-How-to-keep-your-documentation-up-to-date.md | ||
About-this-course.md | ||
About-the-Authors.md | ||
References.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# References | ||
|
||
{type: iframe, title:References, width:800, height:600, poster:resources/chapt_screen_images/references.png} | ||
![](https://jhudatascience.org/Documentation_and_Usability/references.html) | ||
|
||
|
||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+132 KB
...ipt/resources/chapt_screen_images/creating-a-smooth-getting-started-section.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+124 KB
manuscript/resources/chapt_screen_images/creating-clarifying-code-comments.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+135 KB
manuscript/resources/chapt_screen_images/creating-handy-reference-guides.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+134 KB
manuscript/resources/chapt_screen_images/creating-helpful-how-to-examples.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+130 KB
...script/resources/chapt_screen_images/documentation-why-its-worth-the-effort.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+125 KB
...ipt/resources/chapt_screen_images/how-to-keep-your-documentation-up-to-date.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+141 KB
.../resources/chapt_screen_images/lessons-we-should-borrow-from-user-designers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+136 KB
...script/resources/chapt_screen_images/what-does-good-documentation-look-like.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.