prastut
commented
4 years ago Dhruv's Feedback
Original: https://docs.google.com/document/d/1htlffxra4IRlcCd5q9Pr1HWzI1GCl_9fukiM05IYzKY/edit#
Overall:
As a user’s perspective This feedback is written with perspective what I felt as a user and suggested if anything was in my mind. The overall content and the flow was well written, especially the part where code is explained. I feel a right amount of content is given there.
Specific Feedback -> Feedback that needs to be addressed
Chapter 0
- Modal height should be according to content in Chapter 0.
Chapter 1
1.2 Description of prerequisites is very vague right now. It should be specific. It comes from a POV that I know how to write basic python scripts for automation so do I cover the appropriate topics. Suggestion: Link a list of concepts that are utmost important. (Idk but if something like W3Schools exists for Python - with sections like basic/advanced)
1.3 What will you build section: The line says Plant contract , a user needs to google what’s a contract there itself. Suggestion: Add something like (don’t worry, explained in the next chapter)
Chapter 2
I overall liked this section, and served its purpose very well.
2.1 In example of blockchain, Etherium doesn’t have a description.
2.2 Can there be a section on “how learning how to create Tezos smart contract be valuable”? I know this goes into a separate issue but a small section can act as an incentive.
Chapter 3
~~3. Chapter 3: SmartPy - 3.1 Intro section mentions helpful links which re-directed me as a user to these links at a time it was unnecessary. It should be renamed as links for reference and ideally mentioned at the end of the current chapter in a box that looks like an option (not a blocker). POV: Experienced developers always go for official documentation at the first hand, people who want to follow a tutorial (like this one) don’t actually need to be redirected.~~
Chapter 6: Testing
Hearing the word testing I thought isn’t it too early even if the user doesn’t know CRUD aps but then from the reasoning I realised that TDD should be critical while writing smart contracts. I think this needs to be explicitly mentioned.
Address by adding more cases.
Chapter 7
Chapter 7: Entry point functions - As a user I wanted to print the passed name after value changes but the print function didn’t work in the console.
Chapter 13:
Has a typo in last line we leave that as an excersise to the user!
Miscellaneous
Random: Font isn’t very enjoyable to read. :sweat_smile:
Specific Feedback -> Being Addressed
Chapter 1
~~1. Chapter 1: Prologue - 1.1 Non-interactive section at right side looks like it is unimplemented. Suggestion: Either make it useful or simply write “This is where you’re going to code” but don’t leave it purposeless.~~
1.4 Get lost section: open issue on Github and Telegram (add the link there as well), it might not bother much at the time the user reads it but it should remain in his mind where to head off in case they see a need in future.
Chapter 3
3.2 Noticed camel-casing missing in Chapter 3: Introduction to Smartpy
3.3 Again, super minor but needs spacing after hash - #import smartpy below
Chapter 4
4. Python concept refresher: This is a brilliant idea but again I think needs to look optional.
FFF's specific feedback:
[ ] Remove rigidity from the editor interface. Possibile solution.
[x] Consistent wording of SmartPy across all references.
[x] In Chapter 10 - reword this recommendation
Bugs noticed while presenting