diff --git a/README.md b/README.md new file mode 100644 index 0000000..ea16254 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Conventions + +## General + +- Hints can be 5-10 lines long and multiple paragraphs. Can contain references to the source material. +- Footnotes should contain a one-liner that provides additional information about the content expected in the markdown block. Always start with an icon that gives a quick visual hint about the content of the footnote. No references here. + +## Page structure + +1. Guidance (guidance.md) + +This section will always be visible while the user is on this page. Provide a short explanation, list of quick references and a TODO checklist. +Avoid using tables in this section. + +1. KPG Guidance + +- type: "guidance-box" +- variant: "sky" + +Provide a concise summary of the key concepts and principles of KPG related to the page. + +2. EPG Guidance + +- type: "guidance-box" +- variant: "amber" + +Provide a concise summary of the key concepts and principles of EPG related to the page, detailing the scoring criteria. +This is the **only** place where scoring criteria should be mentioned. + +3. Einleitungsabsatz + +- type: "markdown" + +This is the section where the user describes the goal of the current chapter. Provide a hint accordingly. No footnote is necessary here. + +... +Content boxes, prepended by guidance boxes if necessary. +... + +N. Qualitätsprüfung +- type: "guidance-box" +- variant: "slate" + +The final checklist to ensure that all necessary elements are included and correctly filled out on the page. This should be a comprehensive list that covers all aspects of the page's content and structure, ensuring that it meets the standards for both KPG and EPG. +Do not repeat the scoring points here.