diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 42 |
1 files changed, 19 insertions, 23 deletions
@@ -1,34 +1,30 @@ -In lack of good git documentation and manuals, I started by own. +For lack of good Git documentation and manuals, I started my own. This manual is aimed at technical people. -It seems to be lack of well written manuals, and Git's online -documention itself is atrocious. While I do not except the -writers to have taken any course in pedagogy or didactics, or -even have any practical experience, I at least expect the -writters to try to keep those aspects in mind, but that does -not seem to be the case. +There seems to be a lack of well-written manuals, and Git's online +documentation itself is atrocious. While I do not expect the +writers to have taken any course in pedagogy or didactics, or even +have any practical experience, I at least expect the writers to try +to keep those aspects in mind, but that does not seem to be the case. Documentation should first introduce the concept, then the -implementation; that is, first how to get started, than what -they are doing*. In other words, first how to create a Git -repository and the absolute essantials, than introduce Git -itself. Not first taking about what Git is, readers want to -read the chapters in their order, if they do not have anything -specific in mind. +implementation; that is, first how to get started, then what it is +doing*. In other words, first how to create a Git repository and the +absolute essentials, then introduce Git itself. Readers want to read +the chapters in their order, if they do not have anything specific in +mind. -Documentation should then give you breif a documentation of -everything you need to know in the order of its imporantance, -then, iterate to the more advanced. +Documentation should then give you brief documentation of +everything you need to know in the order of its importance, then +iterate to the more advanced. -But one of the most important part is not to start with -dangerous commands just because it is easier to be lazy with -them. Try to do it right from the beginning, otherwise the -wrong way will stick in the reader's memory. +One of the most important parts is not to start with dangerous +commands just because it is easier. Try to do it right from the +beginning, otherwise the wrong way will stick in the reader's memory. * This is a concept called ‘concrete before abstract’. While I - disagree that it is always the best practices, I do think so - in this case. - + disagree that it is always the best practice, I do think so in + this case. |