Simply Explained
----------------

                 Key: GEOT-3954
                 URL: https://jira.codehaus.org/browse/GEOT-3954
             Project: GeoTools
          Issue Type: New Feature
          Components: docs
    Affects Versions: 8.0-M3
            Reporter: Jody Garnett
            Assignee: Jody Garnett
            Priority: Trivial


I recently attended a nice talk on documenting open source projects.

One of the top tips was to never use the word "simply". While us developers 
like to use "simply" to imply it "logically follows that"; if no the off chance 
the "simple" functionality being provided does not function we are left with 
the situation that - the user is not helped; and they feel stupid (and thus 
won't ask for help).

We used the word "simply" 52 times in our docs (mostly in the developers guide 
and a bit in the OSGi instructions).

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

------------------------------------------------------------------------------
All the data continuously generated in your IT infrastructure 
contains a definitive record of customers, application performance, 
security threats, fraudulent activity, and more. Splunk takes this 
data and makes sense of it. IT sense. And common sense.
http://p.sf.net/sfu/splunk-novd2d
_______________________________________________
Geotools-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/geotools-devel

Reply via email to