keep-the-caveat-with-the-number
Eine Zahl und ihr Vorbehalt müssen ein Artefakt sein. Zwei Absätze driften auseinander; eine Komponente kann das nicht.
Verliehen von der Person, die die Karte gelesen hat — nicht von der Datei über sich selbst behauptet. Eine Karte, die der Agent während eines Laufs mit nicht vertrauenswürdigen Inhalten destilliert, kommt kontaminiert zur Welt und wird bis zur Prüfung zurückgehalten, bevor sie jemals abgerufen wird.
Wann sie in den Sinn kommt
- ein Benchmark-Ergebnis veröffentlichen
- eine Kennzahl auf eine Seite schreiben
- die Zahl braucht Kontext
- eine Messung zusammenfassen
In Vermeiden und Prüfen steckt meist der Wert. Tun ist der Abschnitt, den alle schreiben.
Der Kartentext oben ist eine Übersetzung. Das englische Original ist das, was die CLI importiert, was der Agent zur Laufzeit liest und was der Hash unten bezeugt.
Auslöser
Sie platzieren eine gemessene Kennzahl irgendwo, wo ein Leser sie sehen wird: ein README, eine Landingpage, Release Notes, ein Dashboard, ein Bericht. Die Zahl ist wahr, und sie braucht einen Satz daneben, um nicht in die Irre zu führen — die Stichprobe war klein, der Ausschnitt war leicht, der Effekt war nicht signifikant, der Benchmark war unserer.
Das gilt nicht für eine Zahl, deren Bedeutung für sich allein vollständig ist. „Build dauerte 41 Sekunden" braucht nichts.
Tun
- Schreiben Sie den Vorbehalt zuerst, vor der Zahl. Wenn Sie die Einschränkung nicht in einem Satz formulieren können, verstehen Sie die Messung noch nicht gut genug, um sie zu veröffentlichen.
- Machen Sie den Vorbehalt strukturell fest verbunden. Platzieren Sie ihn in derselben Komponente, derselben Tabellenzeile, demselben Funktions-Return — etwas, das die Zahl nicht ohne ihn rendern kann.
- Platzieren Sie ihn über der Zahl, oder daneben. Nicht darunter.
- Machen Sie die Zahl selbst abgeleitet: Lesen Sie sie aus dem Artefakt, das die Messung erzeugt hat, damit sie sich bewegt, wenn sich die Messung bewegt.
Vermeiden
Die Zahl in der Überschrift und der Vorbehalt in einer Fußnote, einem Sternchen, einem eingeklappten Abschnitt oder dem Absatz danach. Das ist überall derselbe Fehler mit anderem Styling: Der Leser bildet zuerst die Überzeugung, und eine später eintreffende Korrektur muss eine bereits bestehende Überzeugung überwinden.
Vermeiden Sie auch die Version zweiter Ordnung — eine Komponente, die die Zahl auch ohne Vorbehalt rendern kann. Wenn die Einschränkung ein optionales Argument ist, wird sie weggelassen, und zwar von jemandem, der einen Absatz strafft und nie beabsichtigt hat, die Bedeutung zu ändern.
Und paraphrasieren Sie keinen Vorbehalt, der sorgfältig formuliert wurde. Beim Umformulieren wird aus „für sich allein nicht signifikant" schnell „nahezu signifikant".
Prüfen
Versuchen Sie, die Zahl ohne den Vorbehalt zu schreiben, und beobachten Sie, wie es scheitert. Löschen Sie das Einschränkungs-Argument, oder setzen Sie eine nackte Zahl auf eine Seite, und führen Sie den Build aus.
Wenn es kompiliert, ist die Paarung eine Konvention statt eines Mechanismus, und Konventionen überleben genau so lange, wie es niemand eilig hat.
Risiko
Übertrieben angewendet macht das gewöhnliches Reporting schwerfällig: Nicht jede Zahl ist ein Benchmark, und ein Vorbehalt bei einer Zahl, die keinen braucht, trainiert Leute darauf, Vorbehalte zu überspringen.
Das schwerere Risiko ist, dass sich ein Mechanismus wie die ganze Antwort anfühlt. Eine Komponente, die immer irgendeinen Vorbehalt rendert, prüft nicht, ob es der richtige ist. Der Satz muss immer noch ehrlich von einem Menschen geschrieben werden; dies verhindert nur, dass er nachträglich weggelassen wird.
Verwenden
Die Karte ist Daten. Klonen Sie das Repository und importieren Sie sie über den Pfad — was über das Netz kommt, gilt als kontaminiert und wird bis zur Freigabe zurückgehalten. Das ist das gewünschte Verhalten und der Grund, warum es hier keinen Einzeiler-Installer gibt.
git clone https://github.com/brcampidelli/chimera-agent.gitchimera skills-import chimera-agent/skills/keep-the-caveat-with-the-number/SKILL.mdIntegrität
SHA-256 der Datei in der veröffentlichten Fassung. Wer sie importiert, kann prüfen, dass das Empfangene dem entspricht, was diese Seite gezeigt hat.
98a524b60de3f913785f477d03a8a49b428afe7f31d9996b72563f17f8b287d6