Giter Site home page Giter Site logo

dtc-glossary's Introduction

dtc-glossary

A repository for collaboration on a glossary of digital twins and digital twin technology from the Digital Twin Consortium.

Criteria for including terms

Sometimes less is more. Some relevant questions to ask about a candidate term include:

  • Does the term add value in the form of clarification or context that is not available in a common dictionary?
  • Does the term provide a place to reference other DTC-defined content?
  • Does the term solve a terminology problem for the author of a digital twin use case or some other product of the DTC?
  • Is the term industry-specific?
    • The glossary is not intended to cover industry-specific domains for which one might build a digital twin system.
    • For example “bridge abutment”, “rotator cuff”, “supply chain”, “financial asset”, etc. probably belong in a different glossary.
  • Is the term implementation-specific?
    • This glossary is not the place to describe the terms of a particular implementation approach.
    • We may have entries for types of technology relevant to digital twins, and those entries may list (and link to) specific examples.
  • Does the definition apply across all industry domains?
  • Is the term really necessary? What problems would be caused if it were omitted?

Template for new entries

Before submitting new entries, author's should first reference: Github's Contributor Guidelines.

Only the formal definition following the template > A {term} is a {broader term} that {differentiating clause}. is required--other content is optional.

{Term}

A {term} is a {broader term} that {differentiating clause}.

{Elaboration. In other words... Analogous to...}

{Examples... Examples include...}

{Counter-Examples... ____ is not a {term}}

{Motivation. Why {term} is important for digital twins...}

{Pictures: name of picture }

Alternate terms

Narrower terms

  • [{narrower term 1}(#narrower-term-1)]
  • [{narrower term 2}(#narrower-term-2)]

Related terms

  • A {term} {relational verb phrase} a {related term}.
  • A {term} {relational verb phrase} a {related term}.

*Back to the (Table of Contents)(#Table-of-Contents)


{Term}

A {term} is a {broader term} that {differentiating clause}.

{Elaboration. In other words... Analogous to...}

{Examples... Examples include...}

{Counter-Examples... ____ is not a {term}}

{Motivation. Why {term} is important for digital twins...}

{Pictures: name of picture }

Alternate terms

Narrower terms

  • [{narrower term 1}(#narrower-term-1)]
  • [{narrower term 2}(#narrower-term-2)]

Related terms

  • A {term} {relational verb phrase} a {related term}.
  • A {term} {relational verb phrase} a {related term}.

*Back to the (Table of Contents)(#Table-of-Contents)



### Formal Definition

The formal definition should be a complete sentence following the template

`> A {term} is a [{broader term}](#broader-term) that {differentiating clause}.`

For example

`> A kangaroo is a marsupial that lives in Australia, hops, and is a good boxer.`

(but create a hyperlink to "marsupial" if it is defined elsewhere in the glossary.)

### Context

This section includes elaboration, examples, counter-examples, motivations, pictures and clarifies the meaning and usage of the term.

### Alternate Terms

These can use complete sentences to indicate if the alternate term is non-preferred or to explain the context in which the synonym is commonly used. If there is an entry for the alternate term, link to it.

### Narrower Terms

These are hyperlinks to entries "lower" in the taxonomic hierarchy. For example, the entry for "kangaroo" might list the "narrower" terms: "red kangaroo", "eastern grey kangaroo", "western grey kangaroo", and "antilopine kangaroo".

### Related Terms

These should be complete sentences that describe how the {term} relates to some other term. For example:

```markdown
- A digital twin is implemented in a [digital twin system](#digital-twin-system).
- A digital twin has a corresponding [physical twin](#physical-twin).
- A digital twin is part of a [cyber-physical system](#cyber-physical-system).

Non-Preferred Term

You may include entries for non-terms or synonyms simply as a place to link back to the primary entry.

## {Non-Preferred Term}

Use [{term}(#term)] instead.

*Back to the (Table of Contents)(#Table-of-Contents)

---

dtc-glossary's People

Contributors

caseymullen avatar skyleromg avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

dtc-glossary's Issues

Use a Wiki instead of a document

I think what has been provided is good, but it mixes definitions with encyclopedia type of explanations. Both are good, but both are not glossary entries. I think you also need to add references, standards, user scenarios, architectures, FAQ, "How To" Guides, " etc.

Look at the Glossary for the OMG DIDO-RA:

https://www.omgwiki.org/dido/doku.php?id=dido:public:ra:xapend:xapend.a_glossary:start

This allows

  • Each term to be developed and maintained independent of the entire document
  • Each term as a clean URI that points directly to the term for use in other documents and by the wider community
  • Each term can have a discussion section
  • There can be different templates for each kind of term that has the boilerplate provided for that term
  • There can be private and a public area of the glossary. Terms that are "approved" can move from private to public
  • Public terms are searchable by search engines, making them more likely to be used by outside groups
  • It is easy to link definitions together to make a more natural web experience
  • Every version of every term is kept and can be referred to for historical reasons
  • Using the automatic backlink tracing capability allows for a good review when terms need to be updated/modified to ensure you don't break other things during the upgrade process.
  • You can de-conflict overloaded terms

If you are interested, I would be glad to help with this using the OMG wiki structure as seen in DIDO-RA

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.