Описание
SimpleEnglish — это специализированный навык агента, размещенный на GitHub, разработанный для того, чтобы Большие Языковые Модели (LLMs) могли создавать техническую документацию в соответствии со стандартами упрощенного технического английского ASD-STE100. Этот проект решает критическую необходимость в ясной, недвусмысленной и согласованной технической коммуникации, особенно в отраслях, где точность имеет первостепенное значение, таких как аэрокосмическая и оборонная.
Читать далее
Репозиторий содержит различные компоненты, необходимые для функциональности навыка, включая `.agents/plugins`, `.claude-plugin`, `.codex-plugin` и `skills/simple-english`. Эти элементы облегчают интеграцию руководящих принципов написания на упрощенном техническом английском (STE) в выводы LLM. Проект также включает `prompts`, чтобы направлять LLM, `examples`, чтобы продемонстрировать навык в действии, и `evals` для строгого тестирования и проверки сгенерированного контента на соответствие правилам STE.
Регулярные обновления и коммиты, как видно из истории коммитов для различных директорий, указывают на активную разработку и доработку навыка. Например, недавние коммиты сосредоточены на подключении хуков Codex, настройке полезных нагрузок Claude и удалении противоречивых элементов из навыка, что обеспечивает его надежность и точность. Компонент `tools/ste-dictionary` дополнительно поддерживает соблюдение STE, предоставляя контролируемый словарь и возможности проверки выбора слов.
SimpleEnglish особенно ценен для разработчиков и технических писателей, стремящихся использовать ИИ для генерации документации, сохраняя при этом высокие стандарты ясности и соответствия. Автоматизируя применение правил STE, он помогает уменьшить двусмысленность, улучшить читаемость и упростить процесс рецензирования технических руководств, инструкций и других критически важных документов. Открытая природа репозитория GitHub поощряет вклад сообщества и дальнейшие улучшения навыка.
- КатегорияИнструменты обработки естественного языка
- Модель ценообразованияОткрытый код
- РазвёртываниеОблако
- ПлатформыВеб
Основные функции SimpleEnglish
Соответствие упрощенному техническому английскому ASD-STE100
Навык агента LLM для генерации документации
Интеграция с моделями Claude и Codex
Включает подсказки для направления вывода LLM
Предоставляет примеры текста, соответствующего STE
Инструменты оценки для проверки соблюдения STE
Контролируемый словарь и линтер выбора слов
Модульная архитектура плагинов
Активная разработка и история коммитов
Открытый проект на GitHub
Поддерживает ясное и согласованное техническое письмо
Снижает двусмысленность в контенте, сгенерированном ИИ
Начало работы с SimpleEnglish
Клонируйте репозиторий: используйте `git clone`, чтобы загрузить проект SimpleEnglish на ваш локальный компьютер.
Изучите компоненты: перейдите по директориям, таким как `skills/simple-english`, `prompts` и `evals`, чтобы понять структуру проекта.
Просмотрите примеры: ознакомьтесь с директорией `examples`, чтобы увидеть, как навык агента генерирует документацию.
Используйте инструменты оценки: запустите `evals`, чтобы протестировать соответствие текста, сгенерированного LLM, стандартам ASD-STE100.
Интегрируйте плагины: адаптируйте `.claude-plugin` или `.codex-plugin` для ваших конкретных потребностей интеграции LLM.
Внесите вклад: создайте форк репозитория и отправьте запросы на внесение изменений, чтобы предложить улучшения или новые функции.
Варианты использования SimpleEnglish
- Генерация технической документации
- Создание контента с помощью ИИ
- Контроль качества текста ИИ
- Оптимизация технического письма
- Документация для аэрокосмической и оборонной отрасли
- Инструменты для разработчиков LLM
