Git Product home page Git Product logo

quality.arc42.org-site's Introduction

arc42 Quality model

Here we collect definitions of quality attributes and their relationships .

It's powered by Jekyll and a modified TTSCK theme (see below).

License

As all of the arc42 content, this FAQ is free to use under a liberal Creative-Commons license:

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Jekyll TTSCK Theme

For documentation on this theme, see the original documentation.

We implemented several enhancements over the original theme (e.g. responsive navigation, thx to Falk Hoppe)

How to build & run

Preconditions

You have an environment that allows to run

Build and test

In the root directory, run docker compose up.

How to contribute

Create a fork of https://github.com/arc42/quality.arc42.org-site. Change files and create a pull request with your changes using your fork.

Hint: _todo-qualities contains qualities whose definitions are missing. You may fill those files with content. Then move them to the appropriate folder (e.g. qualities/<letter>/_posts).

Hint: If you add new files you have to clean-rebuild the whole application.

quality.arc42.org-site's People

Contributors

ddebree avatar ewolff avatar exde3297 avatar gernotstarke avatar ichsteffen avatar mesota72 avatar mstier avatar papabravo avatar per-starke avatar sonata82 avatar

Stargazers

 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  avatar  avatar

quality.arc42.org-site's Issues

add code quality and related properties

"code-readability" is already there, but additional qualities could be:

  • low coupling
  • high cohesion
  • modularity
  • adequate code complexity
  • test coverage
  • ?? others?

qualities-counter is wrong

in home.md the counter is wrong:

On this site you find explanations to (currently 92) qualities of software systems and -architectures.

count only qualities, not examples/scenarios

new css style to distinguish between requirements and qualities, visually consistent

something like the greenish color from the requirements-scenario headings shall also be available as background, similar to the arc42-help class.

We need something like that:

<div class="quality-requirement" >
</div>

where:

  • markdown is enabled per default (so we don't need the "markdown=1" in all occurences)
  • bullet-list text has the same size as normal text
  • bullet-lists have proper indentation, like shown here, especially follow-up lines in multi-line text does not left-aligh, but respect the indentation of the first line. See image for an example.

Image

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.