Best practices in writing a glossary entry

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Best practices in writing a glossary entry

Cameron Shorter
Ron, Reese, others,

I notice there is quite a bit of variation in the language people have
been using to create glossary entries [1]. Is anyone aware of documented
best practices in how language should be structured when writing a
glossary entry?

Eg:

* Should a description mention the term it describes?

* How long should the description be?

* Is there a style guide for language that should be use?

[1]
https://docs.google.com/spreadsheets/d/19tulyAEDN5Q5n-u_jlmXIKQjPI2Lwv6fh5Orad1mz1I/edit#gid=0

--
Cameron Shorter
Technology Demystifier
Open Technologies and Geospatial Consultant

M +61 (0) 419 142 254

_______________________________________________
Standards mailing list
[hidden email]
https://lists.osgeo.org/mailman/listinfo/standards
Reply | Threaded
Open this post in threaded view
|

Re: Best practices in writing a glossary entry

Cameron Shorter

Forwarding Reese's email to the standards list - he is having email list problems. ...

On 6/10/19 1:34 pm, Reese W. Plews wrote:
hello Cameron, thank you for the message and for preparing the wiki page.
<snip>

On Sun, Oct 6, 2019 at 4:06 AM Cameron Shorter
[hidden email] wrote:
Hi Reese, 

These ISO guidelines are great and will be good to share.

I've created a stub wiki page for you:
https://trac.osgeo.org/osgeolive/wiki/Glossary%20terms

Which is linked from: https://trac.osgeo.org/osgeolive/wiki

When you try to edit the wiki, you will discover you will need an OSGeo
id. Apply for one, then let me know and I will go through and approve.
(This process is poorly set up by OSGeo).

On 5/10/19 10:10 am, Reese W. Plews wrote:
hello Cameron,

yes, for our ISO work, we use the ISO Directives, Part 2, Clause 16
and 17. that provides the specific rules for the standards developers
to follow. one of the main ideas for the terminology entry is that the
actual definition could be replaced for each term instance the text of
the standard and it will make sense.

the iso directives are available here as html, and other locations as PDF
https://www.iso.org/sites/directives/current/part2/index.xhtml

for the work in TC211 we cannot deviate from those rules. when i make
comments to the standards developers on the terminology, in the early
stages of the work, a number of comments can be about formatting and
grammar. this is especially true for standards developed else where
that would then "come into the ISO process"

please have a look at the directives and we can talk more.

is the wiki page ready?  i had not seen any note about it this week. i
was going to got back through the messages but if i could not find it
i was going to make a google doc page to write some of these things
down or pull them from the messages.
-- 
Cameron Shorter
Technology Demystifier
Open Technologies and Geospatial Consultant

M +61 (0) 419 142 254

_______________________________________________
Standards mailing list
[hidden email]
https://lists.osgeo.org/mailman/listinfo/standards