Keep the wiki pages in wiki/ (publishing pilot) #10
@@ -0,0 +1,46 @@
|
|||||||
|
# AI-promptskabelon
|
||||||
|
|
||||||
|
🌐 [English](AI-Prompt-Template) · **Dansk** · [Bahasa Melayu](AI-Prompt-Template-ms)
|
||||||
|
|
||||||
|
Prompts til review med en AI-agent. Kør reviewet i en **ny session**, hvis samme
|
||||||
|
agent skrev dokumentet: reviewer må ikke være forfatteren.
|
||||||
|
|
||||||
|
## Review et dokument
|
||||||
|
|
||||||
|
```text
|
||||||
|
Review <sti/til/dokument.md> mod tjeklisten <sti/til/qc-type.md>.
|
||||||
|
Giv for hvert nummereret kriterium Pass, Fail eller N-A med dokumentation
|
||||||
|
(citér linjen i dokumentet). List derefter de ikke-beståede Mandatory-kriterier
|
||||||
|
først, giv en dom (Go, Go-with-conditions, No-Go) og den mindste ændring, der
|
||||||
|
ville få hvert ikke-bestået kriterium til at bestå. Redigér ikke dokumentet.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Review kode
|
||||||
|
|
||||||
|
```text
|
||||||
|
Review ændringerne i <sti eller diff> mod <sti/til/qc-programming-sprog.md>
|
||||||
|
og vores kodekonventioner i <sti>. Rapportér hvert kriterium som Pass, Fail
|
||||||
|
eller N-A med fil og linje. Ret intet; list fundene efter alvor.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Review sprog og domæne
|
||||||
|
|
||||||
|
```text
|
||||||
|
Review <dokument> mod qc-language-domain.md. Product Ownerens sprog er
|
||||||
|
<sprog>, og domænet er <domæne>. Kontrollér at hver PO-term i dokumentet
|
||||||
|
findes i ordbogen <sti>, og at ingen IT-term sniger sig ind i et PO-rettet
|
||||||
|
afsnit. List hver uoverensstemmelse med linjen.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Re-review efter rettelser
|
||||||
|
|
||||||
|
```text
|
||||||
|
Re-review kun de kriterier, der fejlede i <tidligere reviewpost>. For hvert:
|
||||||
|
sig om det nye <dokument> nu består, og citér dokumentationen.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tips
|
||||||
|
|
||||||
|
- Giv agenten **én** tjekliste pr. review.
|
||||||
|
- Bed om dokumentation pr. kriterium; et nøgent "Pass" er ikke et review.
|
||||||
|
- Betragt agentens dom som input. Reviewer beslutter.
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
# Templat Prompt AI
|
||||||
|
|
||||||
|
🌐 [English](AI-Prompt-Template) · [Dansk](AI-Prompt-Template-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
Prompt untuk menyemak dengan ejen AI. Jalankan semakan dalam **sesi baharu**
|
||||||
|
jika ejen yang sama menulis dokumen: penyemak tidak boleh penulisnya.
|
||||||
|
|
||||||
|
## Semak dokumen
|
||||||
|
|
||||||
|
```text
|
||||||
|
Semak <laluan/ke/dokumen.md> terhadap senarai semak <laluan/ke/qc-jenis.md>.
|
||||||
|
Bagi setiap kriteria bernombor beri Pass, Fail atau N-A dengan bukti (petik
|
||||||
|
baris dalam dokumen). Kemudian senaraikan kriteria Mandatory yang gagal
|
||||||
|
dahulu, beri keputusan (Go, Go-with-conditions, No-Go) dan perubahan terkecil
|
||||||
|
yang akan menjadikan setiap kriteria yang gagal lulus. Jangan sunting dokumen.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Semak kod
|
||||||
|
|
||||||
|
```text
|
||||||
|
Semak perubahan dalam <laluan atau diff> terhadap <laluan/ke/qc-programming-bahasa.md>
|
||||||
|
dan konvensyen pengekodan kami di <laluan>. Laporkan setiap kriteria sebagai
|
||||||
|
Pass, Fail atau N-A dengan fail dan baris. Jangan betulkan apa-apa; senaraikan
|
||||||
|
dapatan mengikut keterukan.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Semak bahasa dan domain
|
||||||
|
|
||||||
|
```text
|
||||||
|
Semak <dokumen> terhadap qc-language-domain.md. Bahasa Product Owner ialah
|
||||||
|
<bahasa> dan domainnya <domain>. Semak bahawa setiap istilah PO yang digunakan
|
||||||
|
dalam dokumen terdapat dalam kamus <laluan> dan tiada istilah IT yang meresap
|
||||||
|
ke bahagian untuk PO. Senaraikan setiap ketidakpadanan dengan barisnya.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Semak semula selepas pembetulan
|
||||||
|
|
||||||
|
```text
|
||||||
|
Semak semula hanya kriteria yang gagal dalam <rekod semakan terdahulu>. Bagi
|
||||||
|
setiap satu, nyatakan sama ada <dokumen> baharu kini lulus dan petik buktinya.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Petua
|
||||||
|
|
||||||
|
- Beri ejen **satu** senarai semak bagi setiap semakan.
|
||||||
|
- Minta bukti bagi setiap kriteria; "Pass" sahaja bukan semakan.
|
||||||
|
- Anggap keputusan ejen sebagai input. Penyemak yang memutuskan.
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
# AI Prompt Template
|
||||||
|
|
||||||
|
🌐 **English** · [Dansk](AI-Prompt-Template-da) · [Bahasa Melayu](AI-Prompt-Template-ms)
|
||||||
|
|
||||||
|
Prompts for reviewing with an AI agent. Run the review in a **fresh session**
|
||||||
|
if the same agent wrote the document: the reviewer must not be the author.
|
||||||
|
|
||||||
|
## Review a document
|
||||||
|
|
||||||
|
```text
|
||||||
|
Review <path/to/document.md> against the checklist <path/to/qc-type.md>.
|
||||||
|
For every numbered criterion give Pass, Fail or N-A with the evidence (quote
|
||||||
|
the line of the document). Then list the failed Mandatory criteria first,
|
||||||
|
give a verdict (Go, Go-with-conditions, No-Go) and the smallest change that
|
||||||
|
would make each failed criterion pass. Do not edit the document.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Review code
|
||||||
|
|
||||||
|
```text
|
||||||
|
Review the changes in <path or diff> against <path/to/qc-programming-lang.md>
|
||||||
|
and our coding conventions in <path>. Report each criterion as Pass, Fail or
|
||||||
|
N-A with file and line. Do not fix anything; list the findings by severity.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Review the language and domain
|
||||||
|
|
||||||
|
```text
|
||||||
|
Review <document> against qc-language-domain.md. The Product Owner's language
|
||||||
|
is <language> and the domain is <domain>. Check that every PO term used in the
|
||||||
|
document appears in the dictionary <path> and that no IT term leaks into a
|
||||||
|
PO-facing section. List each mismatch with the line.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Re-review after fixes
|
||||||
|
|
||||||
|
```text
|
||||||
|
Re-review only the criteria that failed in <previous review record>. For each,
|
||||||
|
state whether the new <document> now passes and quote the evidence.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tips
|
||||||
|
|
||||||
|
- Give the agent **one** checklist per review.
|
||||||
|
- Ask for evidence per criterion; a bare "Pass" is not a review.
|
||||||
|
- Treat the agent's verdict as input. The reviewer decides.
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
# Beskrivelse
|
||||||
|
|
||||||
|
🌐 [English](Description) · **Dansk** · [Bahasa Melayu](Description-ms)
|
||||||
|
|
||||||
|
## Hvad en tjekliste indeholder
|
||||||
|
|
||||||
|
Hver `qc-<type>.md` har samme form:
|
||||||
|
|
||||||
|
| Afsnit | Indhold |
|
||||||
|
| --- | --- |
|
||||||
|
| `## Metadata` | `ID` (fx `QC-US-001`), `CrossReference` til relaterede tjeklister, `DomainLanguages` |
|
||||||
|
| `## Version History` | Dato, status, forfatter, reviewer, ændring |
|
||||||
|
| `## Purpose` | Hvorfor artefakttypen findes, og hvad tjeklisten beskytter |
|
||||||
|
| `## Quality Criteria Checklist` | Den nummererede kriterietabel |
|
||||||
|
| `## Common Defects` | De fejl, reviewere faktisk finder |
|
||||||
|
| `## Traceability Rule` | Hvad artefaktet skal spore *tilbage* til og *frem* til |
|
||||||
|
|
||||||
|
## Kriterietabellen
|
||||||
|
|
||||||
|
| # | Criterion | Level | ISO/IEC 25010 Characteristic(s) | Notes |
|
||||||
|
| --- | --- | --- | --- | --- |
|
||||||
|
| 2 | Written in "As a / I want / So that" form | Mandatory | Usability | |
|
||||||
|
|
||||||
|
- **Mandatory**: grundniveauet, hver instans skal opfylde.
|
||||||
|
- **Optional**: avanceret; kan udskydes med en begrundelse.
|
||||||
|
- **ISO/IEC 25010-egenskab**: hvilken produktkvalitetsegenskab kriteriet
|
||||||
|
beskytter (Functional Suitability, Reliability, Usability, Maintainability,
|
||||||
|
Security, Compatibility, ...). Den lader en reviewer se, *hvilken slags*
|
||||||
|
kvalitet et ikke-bestået kriterium bringer i fare, ikke blot at det fejlede.
|
||||||
|
|
||||||
|
## ID'er og versioner
|
||||||
|
|
||||||
|
- En tjeklistes ID er `QC-` plus kortkoden for den artefakttype, den dækker: `QC-BC-001`, `QC-UC-001`, `QC-ERD-001`.
|
||||||
|
- Versionen er uafhængig af ethvert reviewet dokument og stiger kun, når selve tjeklisten revideres.
|
||||||
|
- Tjeklisten `qc-language-domain.md` (`QC-LANG-001`) er **tværgående**: den gælder ud over typens egen tjekliste for ethvert dokument skrevet på Product Ownerens sprog.
|
||||||
|
|
||||||
|
## Sporbarhed
|
||||||
|
|
||||||
|
Tjeklister henviser til hinanden. *Traceability Rule* i en user story-tjekliste
|
||||||
|
peger tilbage på tjeklisterne for use case-diagram, use case og business case og
|
||||||
|
frem mod accepttests. En reviewer bruger det til at sikre, at et dokument ikke
|
||||||
|
svæver frit af de dokumenter, det afhænger af.
|
||||||
|
|
||||||
|
## Et review, trin for trin
|
||||||
|
|
||||||
|
1. Vælg tjeklisten for artefakttypen (plus `QC-LANG-001`, hvis sproget er relevant).
|
||||||
|
2. For hvert kriterium: notér `Pass`, `Fail` eller `N-A` med dokumentation.
|
||||||
|
3. Giv en dom: **Go**, **Go-with-conditions** eller **No-Go**.
|
||||||
|
4. Ret eller begrund hvert ikke-bestået kriterium, og re-review derefter delta'et.
|
||||||
|
5. Reviewer er aldrig forfatteren.
|
||||||
|
|
||||||
|
Postformatet (en `RC-*`-reviewpost) er defineret af
|
||||||
|
[frameworket](https://git.tirsystem.com/TirSystem/sqa-qc-framework); uden for
|
||||||
|
frameworket duer enhver tabel med de samme kolonner.
|
||||||
|
|
||||||
|
## Tjeklister for kildekode
|
||||||
|
|
||||||
|
`qc-programming-*`-tjeklisterne forudsætter, at dit team har skrevet sine
|
||||||
|
kodekonventioner ned for sproget. De kontrollerer, at koden **følger dem**; de
|
||||||
|
pålægger ikke en egen stil.
|
||||||
|
|
||||||
|
## Licens
|
||||||
|
|
||||||
|
CC BY-SA 4.0. Del og tilpas, også kommercielt, hvis du krediterer TirSystem og
|
||||||
|
udgiver din tilpasning under samme licens.
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
# Huraian
|
||||||
|
|
||||||
|
🌐 [English](Description) · [Dansk](Description-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
## Kandungan senarai semak
|
||||||
|
|
||||||
|
Setiap `qc-<jenis>.md` mempunyai bentuk yang sama:
|
||||||
|
|
||||||
|
| Bahagian | Kandungan |
|
||||||
|
| --- | --- |
|
||||||
|
| `## Metadata` | `ID` (cth. `QC-US-001`), `CrossReference` kepada senarai semak berkaitan, `DomainLanguages` |
|
||||||
|
| `## Version History` | Tarikh, status, penulis, penyemak, perubahan |
|
||||||
|
| `## Purpose` | Mengapa jenis artifak wujud dan apa yang dilindungi senarai semak |
|
||||||
|
| `## Quality Criteria Checklist` | Jadual kriteria bernombor |
|
||||||
|
| `## Common Defects` | Kesilapan yang sebenarnya ditemui penyemak |
|
||||||
|
| `## Traceability Rule` | Apa yang artifak mesti jejak *ke belakang* dan *ke hadapan* |
|
||||||
|
|
||||||
|
## Jadual kriteria
|
||||||
|
|
||||||
|
| # | Criterion | Level | ISO/IEC 25010 Characteristic(s) | Notes |
|
||||||
|
| --- | --- | --- | --- | --- |
|
||||||
|
| 2 | Written in "As a / I want / So that" form | Mandatory | Usability | |
|
||||||
|
|
||||||
|
- **Mandatory**: asas yang mesti dipenuhi setiap instans.
|
||||||
|
- **Optional**: lanjutan; boleh ditangguhkan dengan sebab.
|
||||||
|
- **Ciri ISO/IEC 25010**: ciri kualiti produk yang dilindungi kriteria
|
||||||
|
(Functional Suitability, Reliability, Usability, Maintainability, Security,
|
||||||
|
Compatibility, ...). Ia membolehkan penyemak melihat *jenis* kualiti yang
|
||||||
|
terjejas apabila kriteria gagal, bukan sekadar bahawa ia gagal.
|
||||||
|
|
||||||
|
## ID dan versi
|
||||||
|
|
||||||
|
- ID senarai semak ialah `QC-` ditambah kod ringkas jenis artifak yang diliputinya: `QC-BC-001`, `QC-UC-001`, `QC-ERD-001`.
|
||||||
|
- Versi bebas daripada mana-mana dokumen yang disemak dan hanya bertambah apabila senarai semak itu sendiri disemak semula.
|
||||||
|
- Senarai semak `qc-language-domain.md` (`QC-LANG-001`) ialah **merentas**: ia terpakai, selain senarai semak jenisnya, kepada setiap dokumen yang ditulis dalam bahasa Product Owner.
|
||||||
|
|
||||||
|
## Kebolehjejakan
|
||||||
|
|
||||||
|
Senarai semak saling merujuk. *Traceability Rule* senarai semak user story
|
||||||
|
menunjuk ke belakang kepada senarai semak rajah use case, use case dan business
|
||||||
|
case, dan ke hadapan kepada ujian penerimaan. Penyemak menggunakannya untuk
|
||||||
|
memastikan dokumen tidak terapung bebas daripada dokumen yang menjadi
|
||||||
|
tanggungannya.
|
||||||
|
|
||||||
|
## Satu semakan, langkah demi langkah
|
||||||
|
|
||||||
|
1. Pilih senarai semak untuk jenis artifak (tambah `QC-LANG-001` jika bahasa terpakai).
|
||||||
|
2. Bagi setiap kriteria rekod `Pass`, `Fail` atau `N-A`, dengan bukti.
|
||||||
|
3. Beri keputusan: **Go**, **Go-with-conditions** atau **No-Go**.
|
||||||
|
4. Betulkan atau wajarkan setiap kriteria yang gagal, kemudian semak semula delta.
|
||||||
|
5. Penyemak tidak pernah penulisnya.
|
||||||
|
|
||||||
|
Format rekod (rekod semakan `RC-*`) ditakrifkan oleh
|
||||||
|
[rangka kerja](https://git.tirsystem.com/TirSystem/sqa-qc-framework); di luar
|
||||||
|
rangka kerja, mana-mana jadual dengan lajur yang sama boleh digunakan.
|
||||||
|
|
||||||
|
## Senarai semak kod sumber
|
||||||
|
|
||||||
|
Senarai semak `qc-programming-*` menganggap pasukan anda telah menulis
|
||||||
|
konvensyen pengekodan untuk bahasa itu. Ia menyemak kod **mengikutinya**; ia
|
||||||
|
tidak memaksakan gaya sendiri.
|
||||||
|
|
||||||
|
## Lesen
|
||||||
|
|
||||||
|
CC BY-SA 4.0. Kongsi dan adaptasi, termasuk secara komersial, jika anda
|
||||||
|
mengkreditkan TirSystem dan menerbitkan adaptasi anda di bawah lesen yang sama.
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
# Description
|
||||||
|
|
||||||
|
🌐 **English** · [Dansk](Description-da) · [Bahasa Melayu](Description-ms)
|
||||||
|
|
||||||
|
## What a checklist contains
|
||||||
|
|
||||||
|
Every `qc-<type>.md` has the same shape:
|
||||||
|
|
||||||
|
| Section | Content |
|
||||||
|
| --- | --- |
|
||||||
|
| `## Metadata` | `ID` (e.g. `QC-US-001`), `CrossReference` to related checklists, `DomainLanguages` |
|
||||||
|
| `## Version History` | Date, status, author, reviewer, change |
|
||||||
|
| `## Purpose` | Why the artifact type exists and what the checklist protects |
|
||||||
|
| `## Quality Criteria Checklist` | The numbered criteria table |
|
||||||
|
| `## Common Defects` | The mistakes reviewers actually find |
|
||||||
|
| `## Traceability Rule` | What the artifact must trace *back* to and *forward* to |
|
||||||
|
|
||||||
|
## The criteria table
|
||||||
|
|
||||||
|
| # | Criterion | Level | ISO/IEC 25010 Characteristic(s) | Notes |
|
||||||
|
| --- | --- | --- | --- | --- |
|
||||||
|
| 2 | Written in "As a / I want / So that" form | Mandatory | Usability | |
|
||||||
|
|
||||||
|
- **Mandatory**: the baseline every instance must meet.
|
||||||
|
- **Optional**: advanced; may be deferred, with a reason.
|
||||||
|
- **ISO/IEC 25010 characteristic**: which product-quality characteristic the
|
||||||
|
criterion protects (Functional Suitability, Reliability, Usability,
|
||||||
|
Maintainability, Security, Compatibility, ...). It lets a reviewer see
|
||||||
|
*what kind* of quality a failed criterion puts at risk, not only that it failed.
|
||||||
|
|
||||||
|
## IDs and versions
|
||||||
|
|
||||||
|
- A checklist ID is `QC-` plus the short code of the artifact type it covers: `QC-BC-001`, `QC-UC-001`, `QC-ERD-001`.
|
||||||
|
- The version is independent of any reviewed document and increments only when the checklist itself is revised.
|
||||||
|
- The `qc-language-domain.md` checklist (`QC-LANG-001`) is **cross-cutting**: it applies in addition to the type's own checklist to every document written in the Product Owner's language.
|
||||||
|
|
||||||
|
## Traceability
|
||||||
|
|
||||||
|
Checklists link to each other. The *Traceability Rule* of a user-story
|
||||||
|
checklist points back to use case diagram, use case and business case checklists
|
||||||
|
and forward to acceptance tests. A reviewer uses this to check that a document
|
||||||
|
does not float free of the ones it depends on.
|
||||||
|
|
||||||
|
## A review, step by step
|
||||||
|
|
||||||
|
1. Pick the checklist for the artifact type (plus `QC-LANG-001` if the language applies).
|
||||||
|
2. For every criterion record `Pass`, `Fail` or `N-A`, with evidence.
|
||||||
|
3. Give a verdict: **Go**, **Go-with-conditions** or **No-Go**.
|
||||||
|
4. Fix or justify every failed criterion, then re-review the delta.
|
||||||
|
5. The reviewer is never the author.
|
||||||
|
|
||||||
|
The record format (an `RC-*` review record) is defined by the
|
||||||
|
[framework](https://git.tirsystem.com/TirSystem/sqa-qc-framework); outside the
|
||||||
|
framework any table with the same columns works.
|
||||||
|
|
||||||
|
## Source-code checklists
|
||||||
|
|
||||||
|
The `qc-programming-*` checklists assume your team has written down its coding
|
||||||
|
conventions for the language. They check that code **follows them**; they do
|
||||||
|
not impose a style of their own.
|
||||||
|
|
||||||
|
## Licence
|
||||||
|
|
||||||
|
CC BY-SA 4.0. Share and adapt, including commercially, if you credit TirSystem
|
||||||
|
and release your adaptation under the same licence.
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
# QC-tjeklister
|
||||||
|
|
||||||
|
🌐 [English](Home) · **Dansk** · [Bahasa Melayu](Home-ms)
|
||||||
|
|
||||||
|
Kvalitetskriterier (QC-tjeklister) til review af projektdokumenter og
|
||||||
|
kildekode. Én Markdown-fil pr. artefakttype, hvert kriterium mærket med en
|
||||||
|
ISO/IEC 25010:2023-kvalitetsegenskab. Licens:
|
||||||
|
[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
|
||||||
|
|
||||||
|
| Side | Læs den, når du vil |
|
||||||
|
| --- | --- |
|
||||||
|
| [Beskrivelse](Description-da) | Forstå hvordan en tjekliste er bygget, ID-skemaet, niveauer og sporbarhed |
|
||||||
|
| [Installation](Install-da) | Bruge tjeklisterne alene eller som submodul |
|
||||||
|
| [AI-promptskabelon](AI-Prompt-Template-da) | Bede en AI-agent reviewe et dokument eller kode mod en tjekliste |
|
||||||
|
|
||||||
|
## Tjeklister
|
||||||
|
|
||||||
|
| Gruppe | Filer |
|
||||||
|
| --- | --- |
|
||||||
|
| Forretning og analyse | `qc-business-case`, `qc-stakeholder-analysis`, `qc-kpi`, `qc-business-model-canvas`, `qc-bpmn`, `qc-governance`, `qc-milestones-gateways` |
|
||||||
|
| Krav | `qc-use-case-diagram`, `qc-use-case`, `qc-user-story` |
|
||||||
|
| Design | `qc-domain-model`, `qc-ssd`, `qc-operation-contract`, `qc-sequence-diagram`, `qc-dcd`, `qc-erd`, `qc-adr` |
|
||||||
|
| Ordforråd, sprog, domæne | `qc-dictionary`, `qc-language-domain` |
|
||||||
|
| Kildekode | `qc-programming-python`, `-c`, `-cpp`, `-csharp`, `-shell` |
|
||||||
|
|
||||||
|
Tjeklisterne er kvalitetsporten i
|
||||||
|
[SQA and QC Framework](https://git.tirsystem.com/TirSystem/sqa-qc-framework),
|
||||||
|
som monterer dette repository i `framework/qc/`. De kan bruges uden det.
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
# Senarai Semak QC
|
||||||
|
|
||||||
|
🌐 [English](Home) · [Dansk](Home-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
Senarai semak kriteria kualiti (QC) untuk menyemak dokumen projek dan kod
|
||||||
|
sumber. Satu fail Markdown bagi setiap jenis artifak, setiap kriteria ditandai
|
||||||
|
dengan ciri kualiti ISO/IEC 25010:2023. Dilesenkan
|
||||||
|
[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
|
||||||
|
|
||||||
|
| Halaman | Baca apabila anda mahu |
|
||||||
|
| --- | --- |
|
||||||
|
| [Huraian](Description-ms) | Memahami cara senarai semak dibina, skema ID, tahap dan kebolehjejakan |
|
||||||
|
| [Pemasangan](Install-ms) | Menggunakan senarai semak secara bersendirian atau sebagai submodul |
|
||||||
|
| [Templat Prompt AI](AI-Prompt-Template-ms) | Meminta ejen AI menyemak dokumen atau kod terhadap senarai semak |
|
||||||
|
|
||||||
|
## Senarai semak
|
||||||
|
|
||||||
|
| Kumpulan | Fail |
|
||||||
|
| --- | --- |
|
||||||
|
| Perniagaan dan analisis | `qc-business-case`, `qc-stakeholder-analysis`, `qc-kpi`, `qc-business-model-canvas`, `qc-bpmn`, `qc-governance`, `qc-milestones-gateways` |
|
||||||
|
| Keperluan | `qc-use-case-diagram`, `qc-use-case`, `qc-user-story` |
|
||||||
|
| Reka bentuk | `qc-domain-model`, `qc-ssd`, `qc-operation-contract`, `qc-sequence-diagram`, `qc-dcd`, `qc-erd`, `qc-adr` |
|
||||||
|
| Perbendaharaan kata, bahasa, domain | `qc-dictionary`, `qc-language-domain` |
|
||||||
|
| Kod sumber | `qc-programming-python`, `-c`, `-cpp`, `-csharp`, `-shell` |
|
||||||
|
|
||||||
|
Senarai semak ini ialah pintu kualiti
|
||||||
|
[SQA and QC Framework](https://git.tirsystem.com/TirSystem/sqa-qc-framework),
|
||||||
|
yang memasang repositori ini di `framework/qc/`. Ia boleh digunakan tanpanya.
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
# QC Checklists
|
||||||
|
|
||||||
|
🌐 **English** · [Dansk](Home-da) · [Bahasa Melayu](Home-ms)
|
||||||
|
|
||||||
|
Quality-criteria (QC) checklists for reviewing project documents and source
|
||||||
|
code. One Markdown file per artifact type, each criterion tagged with an
|
||||||
|
ISO/IEC 25010:2023 quality characteristic. Licensed
|
||||||
|
[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
|
||||||
|
|
||||||
|
| Page | Read it when you want to |
|
||||||
|
| --- | --- |
|
||||||
|
| [Description](Description) | Understand how a checklist is built, the ID scheme, levels and traceability |
|
||||||
|
| [Install](Install) | Use the checklists on their own or as a submodule |
|
||||||
|
| [AI Prompt Template](AI-Prompt-Template) | Ask an AI agent to review a document or code against a checklist |
|
||||||
|
|
||||||
|
## Checklists
|
||||||
|
|
||||||
|
| Group | Files |
|
||||||
|
| --- | --- |
|
||||||
|
| Business and analysis | `qc-business-case`, `qc-stakeholder-analysis`, `qc-kpi`, `qc-business-model-canvas`, `qc-bpmn`, `qc-governance`, `qc-milestones-gateways` |
|
||||||
|
| Requirements | `qc-use-case-diagram`, `qc-use-case`, `qc-user-story` |
|
||||||
|
| Design | `qc-domain-model`, `qc-ssd`, `qc-operation-contract`, `qc-sequence-diagram`, `qc-dcd`, `qc-erd`, `qc-adr` |
|
||||||
|
| Vocabulary, language, domain | `qc-dictionary`, `qc-language-domain` |
|
||||||
|
| Source code | `qc-programming-python`, `-c`, `-cpp`, `-csharp`, `-shell` |
|
||||||
|
|
||||||
|
These checklists are the quality gate of the
|
||||||
|
[SQA and QC Framework](https://git.tirsystem.com/TirSystem/sqa-qc-framework),
|
||||||
|
which mounts this repository at `framework/qc/`. They are usable without it.
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
# Installation
|
||||||
|
|
||||||
|
🌐 [English](Install) · **Dansk** · [Bahasa Melayu](Install-ms)
|
||||||
|
|
||||||
|
## Brug filerne direkte
|
||||||
|
|
||||||
|
Intet at installere. Klon og åbn den tjekliste, du skal bruge.
|
||||||
|
|
||||||
|
Repositoriet er offentligt, så HTTPS virker uden konto:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.tirsystem.com/TirSystem/sqa-qc-checklists.git
|
||||||
|
# eller det skrivebeskyttede GitHub-spejl
|
||||||
|
git clone https://github.com/TirSystem/sqa-qc-checklists.git
|
||||||
|
```
|
||||||
|
|
||||||
|
SSH virker også, hvis du har adgang til `git.tirsystem.com`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone ssh://git@git.tirsystem.com:10022/TirSystem/sqa-qc-checklists.git
|
||||||
|
```
|
||||||
|
|
||||||
|
Det kanoniske repository ligger på `git.tirsystem.com`; GitHub-repositoriet er
|
||||||
|
et skrivebeskyttet spejl.
|
||||||
|
|
||||||
|
## Som submodul i dit projekt
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git submodule add https://github.com/TirSystem/sqa-qc-checklists.git qc
|
||||||
|
git submodule update --init
|
||||||
|
```
|
||||||
|
|
||||||
|
Lås et commit eller tag, så dine reviews kan genskabes; opdatér det med en
|
||||||
|
bevidst commit.
|
||||||
|
|
||||||
|
## Med SQA and QC Framework
|
||||||
|
|
||||||
|
Du installerer ikke dette repository separat. Frameworket monterer det i
|
||||||
|
`framework/qc/` som et indlejret submodul:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git submodule update --init --recursive
|
||||||
|
```
|
||||||
|
|
||||||
|
Hvis `framework/qc/` er tom, kan intet review starte. Se
|
||||||
|
[Install-siden i framework-wikien](https://git.tirsystem.com/TirSystem/sqa-qc-framework/wiki/Install-da).
|
||||||
|
|
||||||
|
## Bidrag med en ændring
|
||||||
|
|
||||||
|
Et nyt eller ændret kriterium er et release-punkt. Ret tjeklisten, tilføj en
|
||||||
|
række i Version History, og behold hvert kriterium mærket med en ISO/IEC
|
||||||
|
25010-egenskab og et niveau.
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
# Pemasangan
|
||||||
|
|
||||||
|
🌐 [English](Install) · [Dansk](Install-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
## Gunakan fail terus
|
||||||
|
|
||||||
|
Tiada apa-apa untuk dipasang. Klon dan buka senarai semak yang anda perlukan.
|
||||||
|
|
||||||
|
Repositori ini awam, jadi HTTPS berfungsi tanpa akaun:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.tirsystem.com/TirSystem/sqa-qc-checklists.git
|
||||||
|
# atau cermin GitHub baca sahaja
|
||||||
|
git clone https://github.com/TirSystem/sqa-qc-checklists.git
|
||||||
|
```
|
||||||
|
|
||||||
|
SSH turut berfungsi, jika anda mempunyai akses ke `git.tirsystem.com`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone ssh://git@git.tirsystem.com:10022/TirSystem/sqa-qc-checklists.git
|
||||||
|
```
|
||||||
|
|
||||||
|
Repositori kanonik berada di `git.tirsystem.com`; repositori GitHub ialah
|
||||||
|
cermin baca sahaja.
|
||||||
|
|
||||||
|
## Sebagai submodul projek anda
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git submodule add https://github.com/TirSystem/sqa-qc-checklists.git qc
|
||||||
|
git submodule update --init
|
||||||
|
```
|
||||||
|
|
||||||
|
Kunci commit atau tag supaya semakan anda boleh diulang; kemas kini dengan
|
||||||
|
commit yang disengajakan.
|
||||||
|
|
||||||
|
## Dengan SQA and QC Framework
|
||||||
|
|
||||||
|
Anda tidak memasang repositori ini secara berasingan. Rangka kerja memasangnya
|
||||||
|
di `framework/qc/` sebagai submodul bersarang:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git submodule update --init --recursive
|
||||||
|
```
|
||||||
|
|
||||||
|
Jika `framework/qc/` kosong, tiada semakan boleh bermula. Lihat
|
||||||
|
[halaman Pemasangan wiki rangka kerja](https://git.tirsystem.com/TirSystem/sqa-qc-framework/wiki/Install-ms).
|
||||||
|
|
||||||
|
## Menyumbang perubahan
|
||||||
|
|
||||||
|
Kriteria baharu atau yang diubah ialah item keluaran. Ubah senarai semak,
|
||||||
|
tambah baris Version History, dan pastikan setiap kriteria ditandai dengan ciri
|
||||||
|
ISO/IEC 25010 dan tahap.
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
# Install
|
||||||
|
|
||||||
|
🌐 **English** · [Dansk](Install-da) · [Bahasa Melayu](Install-ms)
|
||||||
|
|
||||||
|
## Use the files directly
|
||||||
|
|
||||||
|
Nothing to install. Clone and open the checklist you need.
|
||||||
|
|
||||||
|
This repository is public, so HTTPS works without an account:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.tirsystem.com/TirSystem/sqa-qc-checklists.git
|
||||||
|
# or the read-only GitHub mirror
|
||||||
|
git clone https://github.com/TirSystem/sqa-qc-checklists.git
|
||||||
|
```
|
||||||
|
|
||||||
|
SSH works too, if you have access to `git.tirsystem.com`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone ssh://git@git.tirsystem.com:10022/TirSystem/sqa-qc-checklists.git
|
||||||
|
```
|
||||||
|
|
||||||
|
The canonical repository is on `git.tirsystem.com`; the GitHub repository is a
|
||||||
|
read-only mirror.
|
||||||
|
|
||||||
|
## As a submodule of your project
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git submodule add https://github.com/TirSystem/sqa-qc-checklists.git qc
|
||||||
|
git submodule update --init
|
||||||
|
```
|
||||||
|
|
||||||
|
Pin a commit or tag so your reviews are reproducible; update it with a
|
||||||
|
deliberate commit.
|
||||||
|
|
||||||
|
## With the SQA and QC Framework
|
||||||
|
|
||||||
|
You do not install this repository separately. The framework mounts it at
|
||||||
|
`framework/qc/` as a nested submodule:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git submodule update --init --recursive
|
||||||
|
```
|
||||||
|
|
||||||
|
If `framework/qc/` is empty, no review can start. See the
|
||||||
|
[framework Install page](https://git.tirsystem.com/TirSystem/sqa-qc-framework/wiki/Install).
|
||||||
|
|
||||||
|
## Contributing a change
|
||||||
|
|
||||||
|
A new or changed criterion is a release item. Change the checklist, add a
|
||||||
|
Version History row, and keep every criterion tagged with an ISO/IEC 25010
|
||||||
|
characteristic and a level.
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
**QC Checklists**
|
||||||
|
|
||||||
|
- [Home](Home)
|
||||||
|
- [Description](Description)
|
||||||
|
- [Install](Install)
|
||||||
|
- [AI Prompt Template](AI-Prompt-Template)
|
||||||
|
|
||||||
|
**Languages**
|
||||||
|
|
||||||
|
- English: [Home](Home)
|
||||||
|
- Dansk: [Hjem](Home-da)
|
||||||
|
- Bahasa Melayu: [Utama](Home-ms)
|
||||||
Reference in New Issue
Block a user