CONTRIBUTING.md

(szkic — dla wszystkich współpracowników)

Wkład w Przegląd Instrumentów Naukowych#

Dziękujemy za pomoc w rozszerzaniu tego przeglądu.
Ten folder jest zaprojektowany jako minimalny, spójny i przyjazny dla studentów, zgodnie z tą samą triadyczną strukturą stosowaną w projekcie Triadic Frameworks.

Aby utrzymać kanon w czystości i zgodności, prosimy o przestrzeganie poniższych wytycznych podczas dodawania lub udoskonalania plików instrumentów.

1. Użyj szablonu#

Wszystkie nowe pliki instrumentów muszą przestrzegać struktury w:

template.md

Zapewnia to spójność w:

• tonie
• ramach rdzenia wymiarowego
• notatkach reżimowych
• notatkach dotyczących wyrównania lub kontenerów
• klasyfikacji triadycznej (Zielony / Żółty / Czerwony)

Utrzymuj każdy plik krótko — zazwyczaj 6–10 małych sekcji, każda tylko kilka zdań.

2. Wybierz odpowiednią strefę#

Umieść instrument w:

• 01_green_zone/ — stabilna, spójna, niezależna od podłoża
• 02_yellow_zone/ — funkcjonalna, ale oparta na założeniach lub mieszanym reżimie
• 03_red_zone/ — krucha, oparta na wnioskach lub wrażliwa na podłoże

Jeśli nie jesteś pewien, przeszukaj podobne instrumenty i dopasuj najbliższy wzór.

3. Utrzymuj język minimalny i przyjazny#

Ten projekt jest przede wszystkim dla uczniów.
Proszę:

• unikać żargonu specyficznego dla dziedziny, chyba że jest zdefiniowany
• używać krótkich zdań
• utrzymywać wyjaśnienia strukturalne, a nie encyklopedyczne
• unikać niepotrzebnych szczegółów
• skupić się na jasności, a nie na kompletności

Każdy plik powinien być przystępny dla ucznia, który po raz pierwszy spotyka się z narzędziem.

4. Kotwica do rdzenia wymiarowego (SET)#

Każde narzędzie musi zawierać krótką sekcję SET:

• Spin — istotne lub „nieistotne”
• Elec — wykrywanie, detekcja lub „brak”
• Temp — czułość termiczna lub „niewielki wpływ”

To utrzymuje przegląd w zgodzie z szerszym słownikiem Ram Triady.

5. Zachowaj notatki o reżimie triadycznym#

Każdy plik musi zawierać:

• pos‑regime — stabilne, przewidywalne zachowanie
• Q‑regime — przejściowe lub oparte na założeniach zachowanie
• neg‑regime — kruche, nieliniowe lub niestabilne zachowanie

Jedna linia na punkt jest idealna.

6. Notatki dotyczące wyrównania i ograniczenia#

W zależności od strefy:

• Zielony: „Już wyrównane. Tylko warunki brzegowe wymagają wyraźnych granic.”
• Żółty: „Wymaga wyraźnych notatek na temat dryfu, założeń lub wrażliwości na środowisko.”
• Czerwony: „Wymaga ograniczenia: wyraźne granice wokół podłoża, wnioskowania lub stabilności.”

Utrzymaj tę sekcję krótką i praktyczną.

7. Utrzymuj pliki krótkie#

Każdy plik instrumentu powinien mieć:

• 150–300 słów
• bez diagramów
• bez równań
• bez głębokich analiz tematycznych

Celem jest jasność, a nie techniczna głębokość.

8. Utrzymuj czystość folderu#

Podczas dodawania nowych plików:

• używaj małych liter z podkreśleniami
• unikaj spacji
• utrzymuj opisy nazw plików (np. mass_spectrometer.md)
• aktualizuj instrument_list_raw.md tylko w przypadku dodawania nowego typu instrumentu

9. Pozostań zgodny z glosariuszem#

Jeśli wprowadzisz termin, który pojawia się w głównym glosariuszu Ram Triadycznych, połącz go z:

00_overview/glossary_links.md

Nie redefiniuj terminów glosariusza w plikach instrumentów.

10. Bądź miły dla przyszłych czytelników#

Każdy plik powinien pomóc nowemu użytkownikowi poczuć się zorientowanym, a nie przytłoczonym.

Wszystko, co już wiedzą, nadal działa —
ta recenzja po prostu wyjaśnia reżim.

To jest duch projektu.