Giter Club home page Giter Club logo

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.