Продолжим серию постов про "алфавит" AI SWE инструментов - без этого алфавита сложно будет разговаривать о более сложных конструкциях. Ведь они состоят из этих базовых элементов.
Каждая такая буковка вносит свой вклад в свойства системы, каким то образом или улучшая её, или давая дополнительные возможности.
К сути!
▶️ Начнём с frontmatter - это расширение стандарта Markdown синтаксиса для указания в начале файла небольшого блока данных, в формате YAML. Формат легко гуглится, отделяем чёрточками, между ними пишем свойства в YAML нотации.
Зачем нам frontmatter? Удобная вещь для хранения важных реквизитов файла, которые иначе нужно было бы собирать по файлу, проводя его полную обработку:
- description: самое важное с точки зрения оптимизации поле, я храню в нем короткое, на 1-2 предложения описание содержимого файла.
- "ссылки": различные поля, которые помогают мне "увязывать" контент в мемори банке логическими связями, при этом - потенциально в машиночитаемом виде
▶️ пример "ссылок" :
feature: '[FT-002-3]'
epic: '[EP-002]'
Это ссылка на эпик/фичу с которой связан документ
❓ Какие тэги можно использовать?
Стандарта нет, используем то, что нам нужно знать про файл. В некоторых CMS системах на этих тэгах построены атрибуты файла, которые использует CMS.
Важно отметить, что claude использует frontmatter для файлов описания агентов - там мы пишем
name, description, model, color.❓ А всё таки?
помимо description и epic/feature я использую тэги:
- update: в чем суть последнего обновления файла
- date: дата последнего обновления файла
- status: это DRAFT или ACTIVE документ
- history: перечень последних 5-7 обновлений файла с датами и описанием (не в git же ща ними лезть!)
Ну и всякие другие поля - по обстановке!
#post
@deksden_notes