search

EKGF / ekg-maturity

Maturity Model for the Enterprise Knowledge Graph
https://maturity.ekgf.org
Creative Commons Attribution Share Alike 4.0 International
13 stars 4 forks source link

Update the doc to explain the use of LaTex. #7

Closed DennisWisnosky closed 2 years ago

DennisWisnosky commented 3 years ago

"LaTeX, which is pronounced «Lah-tech» or «Lay-tech» (to rhyme with «blech» or «Bertolt Brecht»), is a document preparation system for high-quality typesetting. It is most often used for medium-to-large technical or scientific documents but it can be used for almost any form of publishing.

LaTeX is not a word processor! Instead, LaTeX encourages authors not to worry too much about the appearance of their documents but to concentrate on getting the right content. For example, consider this document:" https://www.latex-project.org/about/ EKGF uses LaTex as part of its automated publishing process.

DennisWisnosky commented 3 years ago

I want this to be added to the existing doc text.

jgeluk commented 3 years ago

We selected LaTeX as a typesetting and publishing technology for several reasons:

  1. It is based on ASCII files and can therefore easily be stored in a git repository where the git "diff" functionality can show exactly which words or lines have changed, when, by who and for what reason (via a link to issues), utilising the very successful way of working that git and Github have established.
  2. We've looked at other methods such as Google Docs and Asciidoc but in terms of quality of process and published output we think that the combination Github & LaTeX is superior.
  3. The maturity model is just in its first phase, the amount of text that we still need to produce will drastically increase over time and needs to be as structured as possible, avoiding repetition as much as possible by maximising the use of cross-references, glossaries, indexes etc which is all relatively easy to do with LaTeX
  4. At some point, the maturity model's content will be moved into the EKG itself (converted to RDF), where we can construct the final LaTeX output (or parts of it at least) from the EKG in a batch job which would allow any organization to generate their own version of the maturity model, linked to departments and use cases, scoring results over time etc.

For the preparation of a given text fragment, any other tool can be used such as Word, Google Docs or these Github issues. Once a text has been drafted by an individual or a workgroup, someone can put it as LaTeX in a pull request for official review and approval.