Thought I'd get some opinions, before I commit to this style of writing tutorials. I'm writing these tuts for my framework so others can use it it without having to find out how to by just looking through the code. Feel free to be harsh, just please explain what you think is wrong. And thank yall for looking.
www.zoloproject.com
Can I get your oppinion on my tutorials.
[ dev journal ]
[ current projects' videos ]
[ Zolo Project ]
I'm not mean, I just like to get to the point.
[ current projects' videos ]
[ Zolo Project ]
I'm not mean, I just like to get to the point.
1. It's hard to read the top of the text where it appears above a background image. Although this is less of a problem further down the page more contrast would still be an improvement, as the writing doesn't stand out brilliantly.
2. Personally, I'd prefer a larger font-size. I would also prefer that the text not be jammed into a narrow column towards the left of the screen for no apparent reason.
3. The code samples are somewhat stark against the dark background. Perhaps you could either find a darker theme for the code samples, or consider a lighter background for the rest of the page.
4. There are some mistakes with character-escaping in the code samples. See the first sample in tutorial one for instance.
5. There are a few spelling/grammatical errors. A couple of examples from tutorial one include "the later" (should be "the latter"), and "Hellow World" (should be "Hello World" -- I assume this is just a typo). Make sure you run a spell-check and proofread.
Hope that helps a bit!
2. Personally, I'd prefer a larger font-size. I would also prefer that the text not be jammed into a narrow column towards the left of the screen for no apparent reason.
3. The code samples are somewhat stark against the dark background. Perhaps you could either find a darker theme for the code samples, or consider a lighter background for the rest of the page.
4. There are some mistakes with character-escaping in the code samples. See the first sample in tutorial one for instance.
5. There are a few spelling/grammatical errors. A couple of examples from tutorial one include "the later" (should be "the latter"), and "Hellow World" (should be "Hello World" -- I assume this is just a typo). Make sure you run a spell-check and proofread.
Hope that helps a bit!

- Jason Astle-Adams
I don't mind the small text, but it would be nice if there were a little more contrast between it and the background, and a lot more contrast in the code samples (pinky(?) grey on white background is really hard to read). I also don't mind the narrow column of text, but it would be nice if it were centered.
It seems to me that your tutorial is at the wrong level of content and context. The two entries that you have so far read more like example snippets that you might find in a library documentation.
A tutorial should be about teaching concepts while showing how a specific goal can be achieved. What is your framework good for? I suspect your goal is for people to use them in making games. Then think of a very simple smallish game (on the level of complexity of Pong, for example), and write a tutorial that should answer the question: How can your framework be used to write this specific smallish game.
This provides a context hook for the reader. Then you should use the opportunity of having the reader hooked to convey the key concepts that are important in your framework.
A really great tutorial that I have read recently is the LLVM tutorial. It takes the reader through the development of a very small toy language, introducing most of the key concepts of LLVM along the way.
A tutorial should be about teaching concepts while showing how a specific goal can be achieved. What is your framework good for? I suspect your goal is for people to use them in making games. Then think of a very simple smallish game (on the level of complexity of Pong, for example), and write a tutorial that should answer the question: How can your framework be used to write this specific smallish game.
This provides a context hook for the reader. Then you should use the opportunity of having the reader hooked to convey the key concepts that are important in your framework.
A really great tutorial that I have read recently is the LLVM tutorial. It takes the reader through the development of a very small toy language, introducing most of the key concepts of LLVM along the way.
Widelands - laid back, free software strategy
thank you guys, I got a bit a tweaking to do then. I'll put a little game game together and tut' on how to code the game using the framework before I come back for more.
[ dev journal ]
[ current projects' videos ]
[ Zolo Project ]
I'm not mean, I just like to get to the point.
[ current projects' videos ]
[ Zolo Project ]
I'm not mean, I just like to get to the point.
"winFunc.function = &TestFunction;"
why hello there HTML encoding.
Seconding what others said, plus:
A) bright gray text on bright gray background = fail
B) why is content squished in a tiny narrow column? There's so much space unused. makes reading cumbersome.
C) it took me about 15 seconds to skim through your entire website (no exaggeration). You may want to include more actual content before you start asking for feedback.
why hello there HTML encoding.
Seconding what others said, plus:
A) bright gray text on bright gray background = fail
B) why is content squished in a tiny narrow column? There's so much space unused. makes reading cumbersome.
C) it took me about 15 seconds to skim through your entire website (no exaggeration). You may want to include more actual content before you start asking for feedback.
Comrade, Listen! The Glorious Commonwealth's first Airship has been compromised! Who is the saboteur? Who can be saved? Uncover what the passengers are hiding and write the grisly conclusion of its final hours in an open-ended, player-driven adventure. Dziekujemy! -- Karaski: What Goes Up...
This topic is closed to new replies.
Advertisement
Popular Topics
Advertisement
Recommended Tutorials
Advertisement