Когда это нужноWhen to reach for itКоли це потрібно
Проект из отчётов, наборов данных, документов, договоров или регламентов либо шаг после копирования kit, где вы решаете, что удалить. Читайте и для кодовой базы: та же таблица позволяет вести по методу те её части, что не код.A project made of reports, datasets, documents, contracts or runbooks, or the step after copying the kit in where you decide what to delete. Read it for a codebase too: the same table lets you run the method on the parts that are not code.Проєкт зі звітів, наборів даних, документів, договорів чи регламентів або крок після копіювання kit, де ви вирішуєте, що видалити. Читайте й для кодової бази: та сама таблиця дає змогу вести за методом ті її частини, що не є кодом.
ТребованияRequirementsВимоги
- Где доступноAvailable inДе доступно
- Каждая загрузка kitEvery download of the kitКожне завантаження kit
- К чему обращаетсяWhat it touchesДо чого звертається
- Читает файлы проектаReads the files of your projectЧитає файли проєкту
- Работает сWorks withПрацює з
- Любой агент, который читает и пишет ваши файлыAny agent that reads and writes your filesБудь-який агент, що читає й пише ваші файли
- Где выполняются шагиWhere the steps happenДе виконуються кроки
- Чат вашего агента и ваши собственные файлы. Ни то ни другое не интерфейс этого сайта, поэтому шаги описаны текстом, а не скриншотами.Your agent's chat and your own files. Neither is an interface of this site, so the steps are text and not screenshots.Чат вашого агента і ваші власні файли. Ні те, ні інше не є інтерфейсом цього сайту, тому кроки описано текстом, а не скриншотами.
- Где это лежит в kitWhere it lives in the kitДе це лежить у kit
docs/PROJECT_SHAPES.md
Три честных ограничения. Там, где ничего нельзя проверить механически, метод вырождается в чек-лист с хорошими манерами. Для одного сплошного документа с одним автором механика тикетов - лишняя нагрузка. Если работа не состоит из файлов, kit сказать нечего: сначала запишите её, тогда это станет проектом.Three honest limits. Where nothing can be checked mechanically, the method degrades to a checklist with good manners. For one flowing document with one author, the ticket machinery is overhead. Where the work is not files, the kit has nothing to say: write it down first, and then it is a project.Три чесні обмеження. Там, де нічого не можна перевірити механічно, метод вироджується в чекліст із гарними манерами. Для одного суцільного документа з одним автором механіка тікетів - зайве навантаження. Якщо робота не складається з файлів, kit нічого не скаже: спершу запишіть її, тоді це стане проєктом.
ШагиStepsКроки
- Пересчитайте пять вещей, которые предполагает метод: рабочая папка с историей, к которой можно откатиться; артефакты; единицы работы с честным статусом; проверки; агент, умеющий читать и писать ваши файлы. Если есть четыре из пяти, метод работает, а дыру вы почувствуете ровно там, где помогла бы недостающая вещь. Если три, сначала заведите четвёртую. Нет истории? Копируйте папку перед большой правкой.Count the five things the method assumes: a workspace with history you can roll back, artifacts, work items with a true status, checks, and an agent that can read and write the workspace. With four of five the method still works and you feel the gap where the missing one would have helped. With three, build the fourth first. No history? Copy the folder before a big change.Перелічіть п'ять речей, які припускає метод: робоча тека з історією, до якої можна відкотитися; артефакти; одиниці роботи з чесним статусом; перевірки; агент, що вміє читати й писати ваші файли. Якщо є чотири з п'яти, метод працює, а дірку ви відчуєте рівно там, де мала допомогти відсутня річ. Якщо три, спершу заведіть четверту. Немає історії? Копіюйте теку перед великою правкою.
- Найдите свой столбец в таблице словаря: софт, данные и аналитика, тексты и документация, юридическое и комплаенс, операции и админ. В нём слова метода в вашей работе: рабочая папка, артефакт, карта, дешёвая, средняя и дорогая проверка, «готово». Заполните свой столбец и держите его в репозитории. Это десять минут, и новичок или агент сможет сопоставить правило с вашей реальностью.Find your column in the vocabulary table: software, data and analysis, writing and documentation, legal and compliance, or operations and admin. It gives the method's words in your work: the workspace, an artifact, the map, a cheap, a middling and an expensive check, and 'done'. Fill in your own column and keep it in the repo. It takes ten minutes and lets a newcomer or an agent map a rule to your reality.Знайдіть свій стовпець у таблиці словника: софт, дані та аналітика, тексти й документація, юридичне та комплаєнс, операції та адмін. У ньому слова методу у вашій роботі: робоча тека, артефакт, карта, дешева, середня й дорога перевірка, «готово». Заповніть свій стовпець і тримайте його в репозиторії. Це десять хвилин, і новачок чи агент зможе зіставити правило з вашою реальністю.
- Найдите свою проверку, спросив себя: что было бы стыдно отправить? Каждый ответ - это проверка. Ищите сумму, которая должна сойтись с другой суммой; имя, которое должно существовать в другом месте; структуру, которая должна держаться; ссылку, которая должна разрешаться; сборку, которая должна получиться. Запишите её один раз командой или описанной процедурой и запускайте.Find your check by asking what you would be embarrassed to send. Each answer is a check. Look for a total that must match another total, a name that must exist elsewhere, a structure that must hold, a thing that must still resolve, a rendering that must succeed. Write it down once with a command or a stated procedure, then run it.Знайдіть свою перевірку, спитавши себе: що було б соромно відправити? Кожна відповідь - це перевірка. Шукайте суму, яка має зійтися з іншою сумою; ім'я, яке має існувати в іншому місці; структуру, що має триматися; посилання, що має розв'язуватися; збірку, що має вдатися. Запишіть її один раз командою або описаною процедурою й запускайте.
- Поставьте эту проверку в
<CHECK_CMD>- единственный плейсхолдер, который обязан заполнить каждый проект. Токены слоя кода<BUILD_CMD>,<TEST_CMD>,<LINT_CMD>и<RUN_CMD>лишь уточняют его, для проектов, где эти четыре вещи различны. Все токены разобраны в разделе как заполнить плейсхолдеры.Put that check into<CHECK_CMD>, the one placeholder every project must fill. The code-layer tokens<BUILD_CMD>,<TEST_CMD>,<LINT_CMD>and<RUN_CMD>only refine it, for projects that have those four distinct things. Fill the placeholders walks through all of them.Поставте цю перевірку в<CHECK_CMD>- єдиний плейсхолдер, який мусить заповнити кожен проєкт. Токени шару коду<BUILD_CMD>,<TEST_CMD>,<LINT_CMD>і<RUN_CMD>лише уточнюють його, для проєктів, де ці чотири речі різні. Усі токени розібрано в розділі як заповнити плейсхолдери. - Составьте свой список признаков мусора.
docs/CODE_QUALITY.mdназывает приметы, которые агент выдаёт охотно, которые выглядят нормально и портят кодовую базу. Ваши зависят от ваших артефактов, например: текст, пересказывающий свой заголовок; число без источника; плейсхолдер, забытый в готовом документе; устаревшая ссылка. Собирайте список из того, что поймали на ревью, а не из воображения.Write your own quality list.docs/CODE_QUALITY.mdnames patterns an agent emits that look fine and rot a codebase. Yours are specific to your artifacts, for example text that restates its heading, a number with no source, a placeholder left in a finished document or a stale cross-reference. Build the list from what you caught in review, not from imagination.Складіть власний список ознак сміття.docs/CODE_QUALITY.mdназиває прикмети, які агент видає охоче, що виглядають нормально й псують кодову базу. Ваші залежать від ваших артефактів, наприклад: текст, що переказує свій заголовок; число без джерела; плейсхолдер, забутий у готовому документі; застаріле посилання. Збирайте список із того, що впіймали на рев'ю, а не з уяви. - Превратите индекс кода в индекс вашего материала: словарь данных, библиотеку формулировок, реестр документов или таблицу источников. Три правила остаются: обращайтесь к нему до поиска, пересобирайте после изменений и замеряйте, как часто он отвечает.Turn the code index into an index of your material: a data dictionary, a clause library, a document register or a table of sources. The three rules stay the same: query it before searching, regenerate it after you change things, and measure how often it answers.Перетворіть індекс коду на індекс вашого матеріалу: словник даних, бібліотеку формулювань, реєстр документів чи таблицю джерел. Три правила лишаються: звертайтеся до нього до пошуку, перезбирайте після змін і міряйте, як часто він відповідає.
- Удалите то, чему нечего применять. Слои и направление зависимостей (
<ARCH_LAYERS>), тонкие точки входа, фасад логирования (<LOGGER>), метки верификации (если ваши артефакты не выдают журнал, по которому можно искать) и ступень компиляции в лестнице уходят. Ваша лестница просто начинается со следующей ступени.Delete what has no subject. Layering and dependency direction (<ARCH_LAYERS>), thin entry points, the logging facade (<LOGGER>), verification tags unless your artifacts produce a log you can grep, and the compile rung of the ladder all go. Your ladder simply starts at the next rung up.Видаліть те, чому нічого застосовувати. Шари й напрям залежностей (<ARCH_LAYERS>), тонкі точки входу, фасад логування (<LOGGER>), мітки верифікації (якщо ваші артефакти не дають журналу, по якому можна шукати) і щабель компіляції в драбині йдуть. Ваша драбина просто починається з наступного щабля. - Если у проекта несколько форм, не плодите своды правил. Держите один и позволяйте командам проверки различаться по областям, как
docs/VALIDATION.mdограничивает проверку видом изменения.If the project has several shapes, do not fork the rulebook. Keep one and let the check commands differ by area, the waydocs/VALIDATION.mdscopes a gate by the kind of change.Якщо в проєкту кілька форм, не плодіть зводи правил. Тримайте один і дозволяйте командам перевірки відрізнятися за ділянками, якdocs/VALIDATION.mdобмежує перевірку видом зміни.
Ваш столбец таблицы словаря лежит в репозитории, самая дешёвая настоящая проверка названа в <CHECK_CMD>, а правила слоя кода, которым нечего применять в вашем проекте, удалены, а не приспособлены.Your own column of the vocabulary table is kept in the repo, the cheapest real check is named in <CHECK_CMD>, and the code-layer rules that have no subject in your project are deleted rather than adapted.Ваш стовпець таблиці словника лежить у репозиторії, найдешевшу справжню перевірку названо в <CHECK_CMD>, а правила шару коду, яким нічого застосовувати у вашому проєкті, видалено, а не пристосовано.
СоветыTipsПоради
- В любом столбце верхняя ступень лестницы обычно за человеком. Это нормальный случай, а не слабость: проверка человеком, которой ещё не было, - не зачёт, а ожидание. См. как доказать правку самой низкой подходящей ступенью.In every column the top rung of the ladder is usually a human. That is the normal case, not a weakness: a human check that has not happened yet is not a pass, it is a pending one. See prove a change with the lowest rung that fits.У будь-якому стовпці верхній щабель драбини зазвичай за людиною. Це нормальний випадок, а не слабкість: перевірка людиною, якої ще не було, - не залік, а очікування. Див. як довести правку найнижчим відповідним щаблем.
- Зачем записывать проверку: в эталонном корпусе kit правило с механической проверкой за спиной выполнялось примерно в 99% случаев, то же правило прозой - в 1-8%. Этой цифре всё равно, из чего сделаны ваши артефакты.Why write the check down: in the kit's reference corpus a directive with a mechanical check behind it was followed about 99% of the time, the same directive as prose 1-8%. The figure does not care what your artifacts are made of.Навіщо записувати перевірку: в еталонному корпусі kit правило з механічною перевіркою за спиною виконувалося приблизно у 99% випадків, те саме правило прозою - в 1-8%. Цій цифрі байдуже, з чого зроблені ваші артефакти.
- Без перевода переносятся в любой столбец: исследование перед действием, разделение «что» и «как», проверяемые фазы, статус из реальности, доказательства вместо рассказов, память между сессиями, учёт расходов и fan-out, параллельная работа над общими файлами и правило, написанное против замеченного сбоя.These carry over unchanged in every column: research before acting, splitting what from how, verifiable phases, status that comes from reality, evidence instead of narration, memory across sessions, cost and fan-out, parallel work on shared files, and authoring a rule against an observed failure.Без перекладу переносяться в будь-який стовпець: дослідження перед дією, розділення «що» і «як», перевірні фази, статус із реальності, докази замість розповідей, пам'ять між сесіями, облік витрат і fan-out, паралельна робота над спільними файлами та правило, написане проти поміченого збою.
Связанные функцииRelated functionsПов'язані функції
- Заполнить плейсхолдеры файла правил под свой проектFill the placeholders of the rules file for your projectЗаповнити плейсхолдери файлу правил під свій проєктЗаполните одиннадцать токенов первого яруса, нужных любому проекту, шесть токенов слоя кода только если проект собирается или запускается, и удалите правила без предмета.Fill the eleven tier-1 tokens every project needs, the six code-layer tokens only if the project builds or runs, and delete the rules that have no subject.Заповніть одинадцять токенів першого ярусу, потрібних усім, шість токенів шару коду лише якщо проєкт збирається чи запускається, і видаліть правила без предмета.
- Доказать, что правка работает, прежде чем объявлять её готовойProve a change works before calling it doneДовести, що правка працює, перш ніж оголошувати її готовоюВозьмите самую дешёвую проверку, которая доказывает именно эту правку, запишите ожидаемое и фактическое и называйте шаг готовым, только прочитав результат.Pick the lowest check that proves this change, write down expected and actual, and call the step done only after you have read the result.Візьміть найдешевшу перевірку, що доводить саме цю правку, запишіть очікуване й фактичне та називайте крок готовим, лише прочитавши результат.
- Влить kit в существующий проект, не потеряв свои файлыMerge the kit into an existing project without losing your filesВлити kit в наявний проєкт, не втративши свої файлиАгент описывает ваш проект, показывает план слияния и останавливается. Ничего не пишется до вашего согласия, а где kit и ваши файлы расходятся, побеждают ваши.The agent inventories your project, shows a merge plan and stops. Nothing is written until you approve, and where the kit and your files disagree, yours win.Агент описує ваш проєкт, показує план злиття й зупиняється. Нічого не пишеться до вашої згоди, а де kit і ваші файли розходяться, перемагають ваші.
- Научить агента искать, а не угадыватьMake the agent look things up instead of guessingНавчити агента шукати, а не вгадуватиФиксированный порядок поиска и, для большого проекта, поддерживаемый индекс вашего материала: каждый путь, символ и API, названные агентом, проверены.A fixed order for finding things and, for a big project, a maintained index of your material, so every path, symbol and API the agent states has been verified.Фіксований порядок пошуку і, для великого проєкту, підтримуваний індекс вашого матеріалу: кожен шлях, символ і API, названі агентом, перевірені.
- Не дать сгенерированному коду сгнитьKeep generated code from rottingНе дати згенерованому коду згнитиСемь шаблонов, которые выглядят нормально и тихо гноят кодовую базу: не пишите их, отмечайте с первого взгляда и блокируйте только новые нарушения.Seven patterns that look fine and quietly rot a codebase: do not write them, flag them on sight, and gate only new violations.Сім шаблонів, що виглядають нормально й тихо гноять кодову базу: не пишіть їх, позначайте з першого погляду й блокуйте лише нові порушення.