[GRASS-dev] v.surf.bspline man page - Man page improvement day

Hamish hamish_b at yahoo.com
Thu Jan 20 01:28:22 EST 2011


Benjamin wrote:
> Excellent. Is it technically feasible to involve the whole
> user community in this? Or would it be easier to restrict
> to devs with SVN write access?

one unfortunate thing about writing documentation is that you have to be
both an expert in the nuances of the subject, and at the same time be
able to look at it from the eyes of a newcomer. it's rather a tricky
balance to craft the words just right. sometimes the wording is just bad,
other times the words are a little awkward on purpose, to get the reader
to think about the idea from the right POV.

e.g. to teach first-year undergraduate students you have to simplify things
a great deal to not bury them, but at the same time you have to be very
careful that those simplifications do not go over the top and become lies
which they will later trust & so make it harder for them to learn the
details later on. (this paragraph was not awkward on purpose, just regular
awkward :)


as per usual, patches welcome from all; those with commit access are
responsible for committing, and they are personally responsible for
reviewing and signing off on anything and everything they commit.


Hamish



      


More information about the grass-dev mailing list