Difference between revisions of "Main Page"

From City Data Model Project Collaboratory
Jump to navigation Jump to search
Line 68: Line 68:
 
start
 
start
 
:Navigate to proposed term page;
 
:Navigate to proposed term page;
:Select "Add Definition;
+
:Select "Add Definition";
:Specify description
+
:Specify description of specialized term
 
What distinguishes this definition of the term?;
 
What distinguishes this definition of the term?;
  
Line 75: Line 75:
 
Why is this specialized definition needed?;
 
Why is this specialized definition needed?;
  
:Specify definition in UML and DL
+
:Specify specialized definition in UML and DL
 
If DL is not sufficient, supplement with SWRL or SHACL;
 
If DL is not sufficient, supplement with SWRL or SHACL;
  
:Publish for review;
+
:Publish for review
 +
Specialized definition status="In Progress";
  
 
:Community reviews proposal;
 
:Community reviews proposal;
Line 94: Line 95:
 
         :Author revisions;
 
         :Author revisions;
 
         :Final review;
 
         :Final review;
         :Specialized definition marked as approved (change protected);
+
         :Specialized definition status="Approved" (change protected);
  
 
stop
 
stop

Revision as of 21:56, 22 October 2019

Welcome to the City Data Model Collaboration Wiki!

We have created this website to enable stakeholders and related standards groups to:

  • Review the contents of the City Data Model.
  • Propose new classes or properties
  • Comment on existing classes
  • Comment on proposed classes
  • Suggest changes and additions

How it works

Anyone with an account can comment on proposed or existing terms, and even propose their own.

Getting started

Want to contribute? Log-in or create an account!

See something missing?

Propose a new class:


How it works

Anyone can propose a new term. Once a term has been proposed, it becomes open for the specification of definitions from the community. The administrators will review all proposed definitions and identify the maximal common definition for the term. The term and resulting set of definitions will then be published as approved in the City Data Model.

Here's a high-level overview of the process that we follow when a new term is proposed for the City Data Model:

<uml> @startuml title Proposing a New Term for the CDM

start

Specify the name of the new class or property;
Provide a natural language description of new term;
New term page created

Term status="proposal";

Community review;

if (Term is captured by an existing class or property?) then (yes)

   :indicate redundancy in comments;
   if (community in agreement?) then (Yes)
       :Close proposal
        Term status="closed";
       stop
   else(No)
       while (undecided) is (Yes)
           :Discuss;
           :Editorial review;
       endwhile(No);
   endif;
   else(No)
   endif;
       :Term status="In Progress";       
       while (Discussion quiescence (or other cutoff criteria)?) is (No)
               :Community proposes definitions;
           endwhile(Yes)
               :Admin specify maximum common definition;
               :Term status="Approved";
       :Publication of final version of term page (change protected),
       including maximum common definition and specialized definitions;

stop

@enduml </uml>

<uml> @startuml title Submitting a definition for a proposed term

start

Navigate to proposed term page;
Select "Add Definition";
Specify description of specialized term

What distinguishes this definition of the term?;

Specify use case(s)

Why is this specialized definition needed?;

Specify specialized definition in UML and DL

If DL is not sufficient, supplement with SWRL or SHACL;

Publish for review

Specialized definition status="In Progress";

Community reviews proposal;
Users suggest revisions/additions to definition (properties, constraints), use cases;

if (Owner accommodates suggestions?) then (Yes)

  :Comment resolved;

else(No)

  :Comment left unresolved;

endif;

Editorial review;
       :Editorial comments to author;
       :Author revisions;
       :Final review;
       :Specialized definition status="Approved" (change protected);

stop

@enduml </uml>

Note: these diagrams were drawn using PlantUML. PlantUML is a handy tool that allows you to create UML (and non-UML) diagrams using simple text descriptions. It's supported by this Wiki to help you contribute more effectively.

To Do

Link to Github
Link to publications (reports, papers, ...)
Add summary of classes / class definitions for each city-level ontology
Set permissions for different user types