Установление единой системы правил оформления для членов команды, повышение удобства использования сайтов для внешних пользователей.
На рынке уже существует множество руководств по оформлению, но после прочтения большинства из них мне кажется, что они либо представляют собой список пунктов с примерами, что затрудняет быстрый доступ к конкретному пункту; либо содержат лишь общие принципы без конкретных примеров, что делает их трудноразборчивыми. В этом руководстве мы объединили лучшие черты обоих подходов — сначала приведены основные принципы, а затем через гиперссылки можно получить доступ к конкретным примерам и пояснениям.
Примечание: Все гиперссылки в данном документе активны и могут использоваться для перехода к соответствующим примерам или источникам информации.
Конец статьи содержит список всех используемых источников и руководств по оформлению, за которые благодарность предыдущим специалистам.
Все ниже приведенные примеры являются правильными, далее указаны часто встречающиеся ошибки при использовании больших и малых букв.
При необходимости проверьте правильное написание слов на официальных сайтах:- Java
Примечание:
В логотипе Docker используется маленькая буква "d" в слове docker, но во всех документах используется форма с большой буквой D — Docker. Это можно сравнить с документацией GitLab по установке GitLab через Docker: https://docs.gitlab.com/ee/install/docker.html.
английский текст в гиперссылках требует пробелов с двух сторон
Chinese text and English words should be separated by a space### Пунктуация без пробелов
Нет пробела между полуширинными знаками пунктуации и другими символами
Следующие примеры предоставлены для того, чтобы помочь вам лучше понять соответствующие стандарты и то, как крупные корпоративные сайты применяют их.
Правильный пример:
GitHub является платформой для хранения кода, управления версиями и сотрудничества. Она позволяет вам и другим работать над проектами из любой точки мира.
Неправильный пример:
GitHub является платформой для хранения кода, управления версиями и сотрудничества.It позволяет вам и другим работать над проектами из любой точки мира.
Ссылка на источник: https://docs.github.com/en/get-started/quickstart/hello-world
Правильный пример:
Вы можете скачать, установить и поддерживать свой собственный экземпляр GitLab.
Неправильный пример:
Вы можете скачать, установить и поддерживать свой собственный экземплярGitLab.
Ссылка на источник: https://about.gitlab.com/install/
Правильно:
Виртуальные машины (VMs) — это абстракция физического оборудования, которая превращает один сервер в множество серверов.
Неправильно:
Виртуальные машины(VMs) являются абстракцией физического оборудования, которое превращает один сервер в множество серверов.
Ссылка на источник: https://www.docker.com/resources/what-container/
Правильно:
Будет автоматически отправлено использование статистики и отчеты об ошибках Google, чтобы помочь нам улучшить Google Chrome.
Неправильно:
Будет автоматически отправленоиспользование статистики и отчеты об ошибках Google, чтобы помочь нам улучшить Google Chrome.
Ссылка на источник: https://support.google.com/chrome/answer/95414?hl=en``` Будет автоматически отправлено использование статистики и отчеты об ошибках Google, чтобы помочь нам улучшить Google Chrome.
> Ссылка на источник: [https://www.google.com/intl/zh-CN/chrome/](https://www.google.com/intl/zh-CN/chrome/)
#### Пример отсутствия пробела между китайским текстом и цифрами:
Правильно:
Подходит для Windows 11 / 10 / 8.1 / 8 / 7 64-битной версии.
Неправильно:
Подходит для Windows 11 / 10 / 8.1 / 8 / 7 64битной версии.
> Ссылка на источник: [https://www.google.com/intl/zh-CN/chrome/](https://www.google.com/intl/zh-CN/chrome/)
#### Пример отсутствия пробела между цифрой и единицей измерения:
Правильно:
Пакет Omnibus GitLab требует около 2.5 ГБ места для хранения при установке.
> Обратите внимание: Между числом 2.5 и единицей измерения GB требуется пробел.
Неправильно:
Пакет Omnibus GitLab требует около 2.5GB места для хранения при установке.
> Ссылка на источник: [https://docs.gitlab.com/ee/install/requirements.html](https://docs.gitlab.com/ee/install/requirements.html)
#### Пример отсутствия пробела перед и после англоязычного текста гиперссылки:
Правильно:
Если вы разработчик с платформы React, вы можете обратить внимание на различие между Vuex и Redux, Redux является наиболее популярной реализацией Flux в экосистеме React.
Если вы разработчик с платформы React, вы можете обратить внимание на различие между Vuex и [Redux](https://github.com/reactjs/redux) в экосистеме React.
```
Пример неправильного оформления: если вы разработчик с опытом работы в React, вам может быть интересно обратить внимание на различия между Vuex и [Redux](https://github.com/reactjs/redux), где Redux является наиболее популярной реализацией Flux в экосистеме React.
> Ссылка на справочник: [https://docs.github.com/en/rest/overview/resources-in-the-rest-api](https://docs.github.com/en/rest/overview/resources-in-the-rest-api)
##### Между английским словом и другим английским словом должен быть пробел
Пример правильного оформления:
```
Hello World!
```
Пример неправильного оформления:
```
HelloWorld!
```
##### Между китайским текстом и английским словом должен быть пробел
Пример правильного оформления:
```
Chrome помогает вам оставаться продуктивным и эффективно использовать ваш браузер через приложения Google, такие как Gmail, Google Pay и Google Assistant.
```
Пример неправильного оформления:
```
Chrome помогает вам оставаться продуктивным и эффективно использовать ваш браузер черезприложения Google, такие как Gmail, Google Pay и Google Assistant.
```
> Ссылка на справочник: [https://www.google.com/intl/zh-CN/chrome/](https://www.google.com/intl/zh-CN/chrome/)
#### Ситуации, когда пробелы не нужны
##### Пробелы перед и после полноконечных знаков препинания не требуются
Пример правильного оформления:
```
Вы можете группировать вкладки, чтобы сохранять связанные веб-страницы в одном рабочем пространстве. Чтобы создать группу вкладок, щелкните правой кнопкой мыши любую вкладку и выберите "Добавить вкладку в новую группу".
```
> Ссылка на справочник: [https://www.google.com/intl/zh-CN/chrome/tips/](https://www.google.com/intl/zh-CN/chrome/tips/)
##### Пробелы между цифрами и градусами не требуются
Пример правильного оформления:
```
Угол, составляющий 90°, это прямой угол.
```
> Объяснение: 90° — это единое понятие, которое не должно разделяться пробелами.
Пример неправильного оформления:
```
Угол, составляющий 90 °, это прямой угол.
```
##### Пробелы между цифрами и процентами не требуются
Пример правильного оформления:
```
Моя текущая зарядка телефона составляет 100%.
```
Пример неправильного оформления:
```
Моя текущая зарядка телефона составляет 100 %.
```
##### Пробелы между полунаклонными знаками препинания и другими символами не требуются
Пример правильного оформления:
```
Экзамен завершен, очень рад!
```
Пример неправильного оформления:
```
Экзамен завершен, очень рад!
```
##### Пробелы между английскими словами и точками не требуются
Пример правильного оформления:
```
All Roads Lead to Rome.
```
Пример неправильного оформления:
```
All Roads Lead to Rome .
```
##### Пробелы перед и после китайского текста в гиперссылках не требуютсяПример правильного оформления:
```
На самом деле Redux не имеет возможности воспринимать слои представлений, поэтому он легко может быть связан с Vue через некоторые [простые связи](https://classic.yarnpkg.com/en/packages?q=redux%20vue&p=1).
```
### Использование знаков препинания
#### Использование дефиса в русском тексте
Правильный пример:
```
Мы недавно кратко описали основные функции ядра Vue — остальная часть этого руководства более подробно охватывает эти функции и другие продвинутые возможности, так что обязательно прочтите весь учебник!
```
> Объяснение: Дефис занимает два места, между ними не должно быть пробелов, а также он должен быть выровнен вертикально.
Неправильный пример:
```
Мы недавно кратко описали основные функции ядра Vue – остальная часть этого руководства более подробно охватывает эти функции и другие продвинутые возможности, так что обязательно прочтите весь учебник!
```
> Ссылка на источник: [https://ru.vuejs.org/v2/guide/](https://ru.vuejs.org/v2/guide/)```
Если вы только начинаете учиться фронтенд-разработке, использование фреймворков как первого шага может быть не лучшим решением — лучше освойте базовые знания перед этим.
```
> Ссылка на источник: [https://ru.vuejs.org/v2/guide/#Vue-js-%E6%98%AF%E4%BB%80%E4%B9%88](https://ru.vuejs.org/v2/guide/#Vue-js-является-чем-то)
#### Использование полноконечных знаков препинания в русском тексте
```
С помощью профиля вы можете отдельно хранить все свои данные Chrome, такие как закладки, история, пароли и другие настройки. Профили идеально подходят для случаев, когда нескольким людям требуется использовать одну машину, либо вам нужно разделить различные аккаунты (например, рабочий и личный).
```
> Ссылка на источник: [https://www.google.com/intl/zh-CN/chrome/browser-features/](https://www.google.com/intl/zh-CN/chrome/browser-features/)
Пример:
```
Вы можете выбрать тему и цвета в соответствии со своими потребностями или настроением (например, "темный режим").
```
> Ссылка на источник: [https://www.google.com/intl/zh-CN/chrome/browser-features/](https://www.google.com/intl/zh-CN/chrome/browser-features/)#### В английских предложениях используются прямые запятые
Пример:
```
You build it, you run it.
```
Противопоказанный пример:
```
You build it,you run it。
```
#### При смешении китайского и английского языков используются полужирные знаки препинания
Пример:
```
Через приложения Google, такие как Gmail, Google Pay и Google Assistant, Chrome помогает вам повысить продуктивность и использовать браузер максимально эффективно.
```
> Ссылка на источник: [https://www.google.com/intl/zh-CN/chrome/](https://www.google.com/intl/zh-CN/chrome/)
#### Числа должны представляться с использованием прямых символов
Пример:
```
Этот торт стоит 1000 юаней.
```
Противопоказанный пример:
```
Этот торт продается за 1000 юаней.
```
#### При наличии целого английского предложения или специального названия, используйте прямые знаки препинания
Пример:
```
Какую фразу произнес Джобс? «Stay hungry, stay foolish.»
```> Ссылки на источники:
>
> [Руководство по китайской копирайтинговой практике](https://github.com/sparanoid/chinese-copywriting-guidelines)
>
> [Основные правила написания и форматирования — Документация GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
>
> [Руководство по китайскому текстовому оформлению](https://zhuanlan.zhihu.com/p/20506092)
>
> [Руководство по китайскому текстовому оформлению для блогов Dubbo](https://dubbo.apache.org/zh/blog/2bkubu-xi-tong-de-wen-ben-zheng-li-fang-an/)
>
> [Руководство по китайскому текстовому оформлению](https://zhiqiang.org/it/chinese-copywriting-guidelines.html)
>
> [Внутренние документальные нормы Vue.js](https://github.com/vuejs/cn.vuejs.org/wiki)
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )