Difference between revisions of "Descriptive title"

(Created page with "<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">That you are publishing your data or code it is important to have a good title for y...")
 
Line 1: Line 1:
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">That you are publishing your data or code&nbsp;it is important to have a good title for your new record.</span></span> <span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Like you probably carefully choose a title for your papers, so you should try to put some effort in creating a good title for othe research outputs.</span></span> <span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">The title will be in any reference to your data or code.&nbsp;&nbsp;While, depending on the repository&nbsp;you are using to publish,&nbsp;you can potentially change the title, even after a record has been published, it is important to get it right and be as descriptive as possible.</span></span>  
+
 
 +
{{Template:Working on}}
 +
 
 +
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">That you are publishing your data or code&nbsp;it is important to have a good title for your new record.</span></span> <span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Like you probably carefully choose a title for your papers, so you should try to put some effort in creating a good title for othe research outputs.</span></span> <span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">The title will be in any reference to your data or code.&nbsp;&nbsp;While, depending on the repository&nbsp;you are using to publish,&nbsp;you can potentially change the title, even after a record has been published, it is important to get it right and be as descriptive as possible.</span></span>
 +
 
 
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Also most people querying a repository&nbsp;will skim quickly through the&nbsp;list of returned records. All they will see initially is the title and the start of the description, until they actually click on one specific record.</span></span>
 
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Also most people querying a repository&nbsp;will skim quickly through the&nbsp;list of returned records. All they will see initially is the title and the start of the description, until they actually click on one specific record.</span></span>
  
Line 6: Line 10:
 
=== '''<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Data example</span></span>''' ===
 
=== '''<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Data example</span></span>''' ===
  
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">""</span></span>
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">"Weather Research and Forecasting (v3.6) model outputs from 2-km Kuala Lumpur urban climate experiments"</span></span>
  
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">In the example above I tried to include:</span></span>
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">In the example above the author tried&nbsp;to include:</span></span>
 +
 
 +
*
 +
<span style="font-family:Arial,Helvetica,sans-serif;"><span style="font-size:medium;">the model name and version -&nbsp;</span></span><span style="color:#c0392b;"><span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Weather Research and Forecasting (v3.6)</span></span></span>
 +
 
 +
*<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">the kind of data -&nbsp;<span style="color:#c0392b;">model outputs</span></span></span>
 +
*<font face="Arial, Helvetica, sans-serif" size="3">simulation resolution -&nbsp;</font><span style="color:#c0392b;"><span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">from 2-km</span></span></span>
 +
*
 +
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">spatial domain</span></span> -&nbsp;<span style="color:#c0392b;"><span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Kuala Lumpur</span></span></span>
 +
 
 +
*
 +
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">subject -&nbsp;<span style="color:#c0392b;">urban climate</span></span></span>
 +
 
 +
*
 +
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">that there is more than 1 experiment&nbsp;-&nbsp;<span style="color:#c0392b;">experiments</span></span></span>
  
&nbsp;
 
  
&nbsp;
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">NB that having used the full model name rather than an acronym clarified to any user not familiar with WRF that this&nbsp;are weather forecast related experiment</span></span>
  
 
&nbsp;
 
&nbsp;
Line 18: Line 35:
 
=== '''<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Code example</span></span>''' ===
 
=== '''<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Code example</span></span>''' ===
  
"<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">CleF - Climate Finder A python based command line&nbsp;tool to query ESGF dataset&nbsp;hosted at NCI"</span></span>
+
"<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">CleF - Climate Finder a&nbsp;python based command line&nbsp;tool to query ESGF datasets hosted at NCI"</span></span>
 
 
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">In the example above I tried to include:</span></span>
 
 
 
*
 
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">the code acronym and full name: CleF - Climate Finder</span></span>
 
  
*
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">In the example above the author&nbsp;tried to include:</span></span>
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">that it is python based - A python</span></span>
 
  
 
*
 
*
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">that it is executed as a command line - command line&nbsp;</span></span>
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">the code acronym and full name: <span style="color:#c0392b;">CleF - Climate Finder</span></span></span>
  
 +
*<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">that it is python based - <span style="color:#c0392b;">a python</span></span></span>
 +
*<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">that it is executed as a command line - <span style="color:#c0392b;">command line tool</span></span></span>
 
*
 
*
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">what it does, including the data to which is applied: tool to query ESGF dataset</span></span>
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">what it does, including the data to which is applied: <span style="color:#c0392b;">to query ESGF datasets</span></span></span>
  
 
*
 
*
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">The specific environment for which it was built: hosted at NCI</span></span>
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">The specific environment for which it was built: <span style="color:#c0392b;">hosted at NCI</span></span></span>

Revision as of 00:52, 18 June 2021

Template:Working on New page under construction

That you are publishing your data or code it is important to have a good title for your new record. Like you probably carefully choose a title for your papers, so you should try to put some effort in creating a good title for othe research outputs. The title will be in any reference to your data or code.  While, depending on the repository you are using to publish, you can potentially change the title, even after a record has been published, it is important to get it right and be as descriptive as possible.

Also most people querying a repository will skim quickly through the list of returned records. All they will see initially is the title and the start of the description, until they actually click on one specific record.

And finally any word in the title is used as a keyword by free text search engine.

Data example

"Weather Research and Forecasting (v3.6) model outputs from 2-km Kuala Lumpur urban climate experiments"

In the example above the author tried to include:

the model name and version - Weather Research and Forecasting (v3.6)

  • the kind of data - model outputs
  • simulation resolution - from 2-km

spatial domainKuala Lumpur

subject - urban climate

that there is more than 1 experiment - experiments


NB that having used the full model name rather than an acronym clarified to any user not familiar with WRF that this are weather forecast related experiment

 

Code example

"CleF - Climate Finder a python based command line tool to query ESGF datasets hosted at NCI"

In the example above the author tried to include:

the code acronym and full name: CleF - Climate Finder

  • that it is python based - a python
  • that it is executed as a command line - command line tool

what it does, including the data to which is applied: to query ESGF datasets

The specific environment for which it was built: hosted at NCI