Subject:      Re: Displaying RPL Function Documentation in RiverWare / Document Revisions
Date:   Fri, 11 Apr 2014 10:08:30 -0600
From:   David Neumann

Re: Reference Draft (4-9-2014), PDF Copy: EmbedRplDoc-Design2014-Phil-04-09.pdf

I have also reviewed the document and provided some written mark ups.   It occurred to me that we should have a higher level description. I'm thinking we need an executive summary that a user can read in a few minutes. I mentioned that to Edie and we decided that I will write one.

Couple other comments. This proposal is really good if we need to leave the frame documents in the current structure. I think it would be better use of our time to change the native documents to a better form, whatever that might be AND improve content as appropriate. Also, I agree with Patrick's comment's below, particularly number 2 about "Expression Types". We aren't documenting those, we are documenting the buttons or Operators.  I would even suggest creating one document (really a database) that contains the predefined functions, statements, and operators (buttons). Then if I want to look up how to check if a slot is valid, it would take me to the IsNaN button and the HasFlag and IsInput functions.   To us, predefined functions and operators are very different, but that distinction is not clear to the user, particularly because we have some operators that look and behave like functions.

David

See Patrick's prior review e-mail (4-10-2014).