Skip to content

Commit

Permalink
Render Leanpub
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Dec 18, 2024
1 parent bd0b294 commit 8cf20fb
Show file tree
Hide file tree
Showing 29 changed files with 112 additions and 0 deletions.
7 changes: 7 additions & 0 deletions manuscript/1-Introduction.md
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)



7 changes: 7 additions & 0 deletions manuscript/10-Other-helpful-features.md
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)



7 changes: 7 additions & 0 deletions manuscript/11-How-to-keep-your-documentation-up-to-date.md
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)



7 changes: 7 additions & 0 deletions manuscript/2-Documentation:-Why-it’s-worth-the-effort!.md
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)



7 changes: 7 additions & 0 deletions manuscript/3-Lessons-we-should-borrow-from-user-designers.md
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)



7 changes: 7 additions & 0 deletions manuscript/4-What-does-good-documentation-look-like?.md
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)



7 changes: 7 additions & 0 deletions manuscript/5-Creating-a-smooth-getting-started-section.md
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)



7 changes: 7 additions & 0 deletions manuscript/6-Creating-helpful-how-to-examples.md
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)



7 changes: 7 additions & 0 deletions manuscript/7-Creating-handy-reference-guides.md
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)



7 changes: 7 additions & 0 deletions manuscript/8-Creating-clarifying-code-comments.md
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)



7 changes: 7 additions & 0 deletions manuscript/9-Obtaining-user-feedback.md
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)



7 changes: 7 additions & 0 deletions manuscript/About-the-Authors.md
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)



7 changes: 7 additions & 0 deletions manuscript/About-this-course.md
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)



14 changes: 14 additions & 0 deletions manuscript/Book.txt
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
7 changes: 7 additions & 0 deletions manuscript/References.md
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.
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.
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.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8cf20fb

Please sign in to comment.