Skip to content

Commit 790d091

Browse files
authored
Create design-guidelines.md
1 parent fdefd15 commit 790d091

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/design-guidelines.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
### 1. Keep the tutorial short
2+
3+
I think this is one of the most important aspects that helped this project grow. Getting a pay-off within five minutes of learning something is remarkable. For brevity, we have to compromise on details. A lot of details are missing from the main tutorial. From explanations on what actually happens when you run those commands to other good practices one could follow.
4+
5+
### 2. Accessibility matters
6+
7+
We want these tutorials to be accessible to as much people as possible. Be it somebody having trouble with language barriers or someone with limited internet speed. Translations help people understand this in languages they're more comfortable with. Keeping the size of this repository small will help with limited bandwidth.
8+
If we see that the web page takes a lot of time to load on computers that doesn't have much processing power or memory, we'll remove contributor HTML files to improve that situation
9+
10+
### 3. Users shouldn't have to install (almost) anything.
11+
12+
We're going on the assumption that most user will have a web browser, text editor and terminal emulator. We want users to be able to go though the tutorial with these.
13+
We don't want user to install node or python to run a web server on local.
14+
15+
16+
### 4. Be generic.
17+
18+
We could make assumptions about what OS most of our users are using or what terminal emulator or text editor they're comfortable with. By not making such assumptions, we give our readers more freedom and include more people.
19+
20+
21+
22+
Feel free to challenge any of the above in issues. I'd love to get feedback from you. Let's have a discussion.

0 commit comments

Comments
 (0)