Skip to content

Commit 646ee47

Browse files
Render Leanpub
1 parent 34610b8 commit 646ee47

29 files changed

+112
-0
lines changed

manuscript/1-Introduction.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 1 Introduction
2+
3+
{type: iframe, title:1 Introduction, width:800, height:600, poster:resources/chapt_screen_images/introduction.png}
4+
![](https://jhudatascience.org/Documentation_and_Usability/introduction.html)
5+
6+
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 10 Other helpful features
2+
3+
{type: iframe, title:10 Other helpful features, width:800, height:600, poster:resources/chapt_screen_images/other-helpful-features.png}
4+
![](https://jhudatascience.org/Documentation_and_Usability/other-helpful-features.html)
5+
6+
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 11 How to keep your documentation up to date
2+
3+
{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}
4+
![](https://jhudatascience.org/Documentation_and_Usability/how-to-keep-your-documentation-up-to-date.html)
5+
6+
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 2 Documentation: Why it’s worth the effort!
2+
3+
{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}
4+
![](https://jhudatascience.org/Documentation_and_Usability/documentation-why-its-worth-the-effort.html)
5+
6+
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 3 Lessons we should borrow from user designers
2+
3+
{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}
4+
![](https://jhudatascience.org/Documentation_and_Usability/lessons-we-should-borrow-from-user-designers.html)
5+
6+
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 4 What does good documentation look like?
2+
3+
{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}
4+
![](https://jhudatascience.org/Documentation_and_Usability/what-does-good-documentation-look-like.html)
5+
6+
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 5 Creating a smooth getting started section
2+
3+
{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}
4+
![](https://jhudatascience.org/Documentation_and_Usability/creating-a-smooth-getting-started-section.html)
5+
6+
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 6 Creating helpful how-to examples
2+
3+
{type: iframe, title:6 Creating helpful how-to examples, width:800, height:600, poster:resources/chapt_screen_images/creating-helpful-how-to-examples.png}
4+
![](https://jhudatascience.org/Documentation_and_Usability/creating-helpful-how-to-examples.html)
5+
6+
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 7 Creating handy reference guides
2+
3+
{type: iframe, title:7 Creating handy reference guides, width:800, height:600, poster:resources/chapt_screen_images/creating-handy-reference-guides.png}
4+
![](https://jhudatascience.org/Documentation_and_Usability/creating-handy-reference-guides.html)
5+
6+
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 8 Creating clarifying code comments
2+
3+
{type: iframe, title:8 Creating clarifying code comments, width:800, height:600, poster:resources/chapt_screen_images/creating-clarifying-code-comments.png}
4+
![](https://jhudatascience.org/Documentation_and_Usability/creating-clarifying-code-comments.html)
5+
6+
7+

0 commit comments

Comments
 (0)