diff --git a/AGENTS.md b/AGENTS.md index c1241dd..deafa31 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -3,6 +3,8 @@ This repository holds reusable, **read-only** CI building blocks and organization-level defaults. Product-specific instructions belong in each product repository. ## Language and product documentation +- For product README creation or edits, follow [Product README guidelines](README_GUIDELINES.md), including language parity and license verification. +- Write documents in English; maintain separate Russian versions of documentation. Intermediate working notes do not require translation. - Discuss requirements and plans in Russian. Use English for Autodesk Fusion UI labels, stable API identifiers and public action input names. - Maintain separate EN/RU user documentation where a product already has both. Never silently replace either language with spoilers or machine-generated placeholders. - Respect existing product architecture, UX contracts, tests and CAD compatibility caveats. diff --git a/README.md b/README.md index 59f6d66..8c62c0d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # 4FusionLab organization profile +[Русская версия](README.ru.md) + Public profile and visual assets for [4FusionLab](https://github.com/4FusionLab). - `profile/README.md` — the organization's public Overview. @@ -8,3 +10,5 @@ Public profile and visual assets for [4FusionLab](https://github.com/4FusionLab) - `assets/avatar.png` — raster avatar for GitHub's profile picture upload. Project documentation and support belong in the individual repositories: [Perfora](https://github.com/4FusionLab/Perfora) (perforation patterns), [Selectra](https://github.com/4FusionLab/Selectra) (similar geometry selection), [Ejix](https://github.com/4FusionLab/Ejix) (volume extraction), [RuEn](https://github.com/4FusionLab/RuEn) (Russian-layout shortcuts), and [Planara](https://github.com/4FusionLab/Planara) (planned surface flattening). + +[Product README guidelines](README_GUIDELINES.md) · [Русская версия правил](README_GUIDELINES.ru.md) diff --git a/README.ru.md b/README.ru.md new file mode 100644 index 0000000..6fd690c --- /dev/null +++ b/README.ru.md @@ -0,0 +1,14 @@ +# Профиль организации 4FusionLab + +[English](README.md) + +Публичный профиль и визуальные материалы [4FusionLab](https://github.com/4FusionLab). + +- `profile/README.md` — общедоступная страница организации. +- `assets/banner.svg` — баннер профиля с редактируемой векторной графикой. +- `assets/avatar.svg` — векторный исходник геометрического аватара 4F. +- `assets/avatar.png` — растровый аватар для загрузки в профиль GitHub. + +Документация и поддержка продуктов находятся в отдельных репозиториях: [Perfora](https://github.com/4FusionLab/Perfora) (перфорация), [Selectra](https://github.com/4FusionLab/Selectra) (выбор похожей геометрии), [Ejix](https://github.com/4FusionLab/Ejix) (извлечение объёмов), [RuEn](https://github.com/4FusionLab/RuEn) (горячие клавиши при русской раскладке) и [Planara](https://github.com/4FusionLab/Planara) (планируемая развёртка поверхностей). + +[Правила README продукта](README_GUIDELINES.ru.md) · [English guidelines](README_GUIDELINES.md) diff --git a/README_GUIDELINES.md b/README_GUIDELINES.md new file mode 100644 index 0000000..2e72fb7 --- /dev/null +++ b/README_GUIDELINES.md @@ -0,0 +1,24 @@ +# Product README guidelines + +[Русская версия](README_GUIDELINES.ru.md) + +Use these rules when creating, reviewing, or changing a 4FusionLab product's main pages. Adapt the length and sections to the product; a planned product must not look like a released one. + +## Structure + +1. Start with the product name, Autodesk Fusion, and one sentence explaining the user's outcome. Add existing product artwork with useful alt text when available; do not invent screenshots. +2. Put links to the other language, downloads when an installable release exists, and support near the top. Link to the actual release or releases page, not a promised download. +3. Explain the current workflow and capabilities, then provide installation steps and the command location. For unreleased work, state its status and omit fictional installation steps. +4. State material limitations, data or save risks, supported geometry and platform status near the relevant claims. Separate manifest support, automated tests and actual native Fusion acceptance. Put critical warnings before the workflow and download instructions. +5. Link existing guides, release notes, development, support and license material as appropriate. Preserve useful examples, screenshots, credits and product-specific detail. Use relative links for files in the repository. + +## Language and accuracy + +- Write documents in English. Maintain a separate Russian version of documentation, with equivalent meaning, warnings, links and examples; intermediate working notes do not require translation. Use `README.md` and `README.ru.md` as the main pair, and link them in both directions. Keep any existing legacy path usable and synchronized or redirect it to the canonical version. +- Keep actual Fusion command and control names in English in both versions. Translate prose and image alt text for the audience. Do not copy an English product description into Russian as a substitute for a translation. +- Verify claims against the relevant code, manifest, release assets and test evidence. Distinguish current behavior from plans and experiments. Avoid precise version numbers or badges that will become stale unless they serve a clear purpose and have an owner. +- Before changing a license statement or badge, inspect the current `LICENSE` and applicable distribution terms, including concurrent work. Link to those terms; do not infer commercial permissions from another product. Never change a license as part of a style edit. + +## Review before delivery + +Check the two language versions section by section for equivalent claims and warnings; check relative file, image and anchor links and the release URL; check that installation names match the shipped archive. Review the diff for removed material and license conflicts. Run the repository's relevant documentation and project checks, and report what was actually verified. A documentation-only change is not native Fusion validation and must follow the shared release policy. diff --git a/README_GUIDELINES.ru.md b/README_GUIDELINES.ru.md new file mode 100644 index 0000000..9dcefbb --- /dev/null +++ b/README_GUIDELINES.ru.md @@ -0,0 +1,24 @@ +# Правила README продукта + +[English](README_GUIDELINES.md) + +Применяйте эти правила при создании, проверке и изменении главных страниц продуктов 4FusionLab. Объём и разделы зависят от продукта; проект в планах не должен выглядеть выпущенным. + +## Структура + +1. В начале укажите название продукта, Autodesk Fusion и одним предложением — результат для пользователя. При наличии добавьте существующее изображение продукта с понятным альтернативным текстом; не выдумывайте скриншоты. +2. Вверху разместите ссылки на другой язык, загрузку при наличии готового релиза и поддержку. Ссылайтесь на фактический релиз или страницу релизов, а не на обещанную загрузку. +3. Опишите текущий сценарий и возможности, затем установку и расположение команды. Если продукт ещё не выпущен, укажите статус и не придумывайте установку. +4. Рядом с соответствующими утверждениями укажите существенные ограничения, риски для данных и сохранения, поддерживаемую геометрию и состояние проверки платформ. Различайте платформы в манифесте, автоматические тесты и реальную проверку в Fusion. Критические предупреждения размещайте до сценария и установки. +5. Добавьте ссылки на имеющиеся руководства, описание релизов, разработку, поддержку и лицензию, где это уместно. Сохраняйте полезные примеры, скриншоты, сведения об авторах и особенности продукта. Для файлов репозитория используйте относительные ссылки. + +## Язык и достоверность + +- Документы ведутся на английском. Для документации поддерживается отдельная русская версия с тем же смыслом, предупреждениями, ссылками и примерами; промежуточные рабочие заметки переводить не требуется. Основная пара — `README.md` и `README.ru.md` со взаимными ссылками. Существующий старый путь сохраняйте рабочим и синхронизированным либо перенаправьте на основную версию. +- В обеих версиях сохраняйте реальные английские названия команд и элементов Fusion. Переводите текст и альтернативные подписи изображений. Английское описание продукта не заменяет перевод на русский. +- Сверяйте утверждения с соответствующим кодом, манифестом, файлами релиза и результатами проверок. Различайте текущую реализацию, планы и эксперименты. Не добавляйте быстро устаревающие номера версий и значки без ясной причины и ответственного за обновление. +- Перед изменением упоминания или значка лицензии изучите текущий `LICENSE` и условия распространения, включая параллельную работу. Ссылайтесь на эти условия; не переносите выводы о коммерческом использовании с другого продукта. Не меняйте лицензию при правках оформления. + +## Проверка перед передачей + +Сверьте смысл, предупреждения и разделы двух языковых версий; проверьте относительные ссылки на файлы, изображения и якоря, адрес релиза и соответствие имён установки архиву. Изучите изменения на предмет потери материалов и конфликтов с лицензией. Выполните уместные проверки документации и проекта и сообщите, что действительно проверено. Изменение документации не подтверждает проверку в Fusion и подчиняется общим правилам публикации.