Re: Rule #1 for documentation

Thanks Reinhard for your remarks. Timing with the Leo project and community has been pretty curious. Now I'm writing a "paper" for JOSS (Journal of Open Source Software [1]) and that implies improving the user documentation. So Reinhard remarks and the rewriting Leo doc are pretty timely.

Re: Rule #1 for documentation

On Wed, Feb 15, 2017 at 1:47 AM, rengel wrote: > > So *for documentation*, it might be better to restrain one's links to the > own website. > ​That's the idea. Edward -- You received this message because you are subscribed to the Google Groups "leo-editor"

Re: Rule #1 for documentation

On Tuesday, February 14, 2017 at 1:19:46 PM UTC-6, Edward K. Ream wrote: > > Here is my new *cardinal rule of documentation*: > > *Thou shalt not put thine audience to sleep* > Leo's web site now contains several revised pages: - Leo's home page now says, "Learn about

Re: Rule #1 for documentation

On Tuesday, February 14, 2017 at 8:19:46 PM UTC+1, Edward K. Ream wrote: > > Here is my new *cardinal rule of documentation*: > > *Thou shalt not put thine audience to sleep* > > The *first *goal of documentation is to intrigue people so that they read > on. > > Documentation is not a novel. I

Rule #1 for documentation

Here is my new *cardinal rule of documentation*: *Thou shalt not put thine audience to sleep* The *first *goal of documentation is to intrigue people so that they read on. Leo's present docs fail miserably in this regard. Imo, Leo's docs contain the right words, but in the wrong places.