Changes between Version 29 and Version 30 of Submitting/Docs


Ignore:
Timestamp:
Oct 6, 2018, 3:18:37 PM (14 months ago)
Author:
wenzeslaus
Comment:

few words about wording

Legend:

Unmodified
Added
Removed
Modified
  • Submitting/Docs

    v29 v30  
    149149
    150150{{{
    151 # optionally, but usually worth it (careful color quantization):
     151# color quantization
     152# optional, but usually worth it
     153# note: may change colors
    152154pngnq -n 128 -s 3 file.png
    153155
     
    173175</div>
    174176}}}
     177
     178== Wording ==
     179
     180When writing documentation, honor existing terminologies, names, and wording as they are used in GRASS GIS. Obviously, the current state is not perfect or completely consistent, so if you identify problems, discuss them with the community and provide suggestions and reasoning for the new wording. If you are an experienced GRASS GIS user, keep in mind new users and their first-time experience with GRASS GIS and their experience with other software. If you are a new user of GRASS GIS, keep in mind current users and stability of "GRASS GIS approach." If new terminologies, not used in GRASS GIS before are needed, please refer first to OGC and OSGeo projects, especially GDAL and PROJ.
     181
     182For example, use "module" not "function" (means something different in programming), "tool" (OK, but too general), "program" (does not cover usage from GUI), or "procedure" (uncommon in this context and similar to workflow) when talking about the individual executables. The word "command" is applicable when talking about what is being executed in the command line.
     183
     184To applicable extent, this applies also to source code comments, user-visible messages and strings, debug messages, APIs, and naming of concepts in general.