Википедия: Руководство по стилю / вычислениям (неудавшееся предложение)

Это неудачное предложение. Консенсус по его реализации не был достигнут в разумные сроки. Если вы хотите возобновить обсуждение, используйте страницу обсуждения или начните обсуждение на деревенском насосе . (Ноябрь 2020 г.) Не подлежал никакому процессу WP: PROPOSAL . При рассмотрении вопроса об очистке в 2017 году на WT: MOS , широкая дискуссия не пришла к консенсусу, что это или должно быть руководящим принципом, что его содержание представляет гораздо больше, чем спорные мнения одного или двух редакторов, или что любой из них должны быть импортированы в любой форме в MOS. Предложения об объединении некоторых из них в более популярную Википедию: WikiProject Computer science / Manual of style дважды (2011, 2018) терпели неудачу.

Ярлык MOS: ВЫЧИСЛЕНИЕ

Эта страница содержит рекомендации по стилю создания и редактирования статей о компьютерах, программном обеспечении, сетях, Интернете и информационных технологиях. Также следует соблюдать другие правила и рекомендации, а также общие правила из Руководства по стилю .

Торговые марки [ править ]

В отношении товарных знаков компьютерной техники соблюдайте правила Википедии и правила стиля в отношении товарных знаков. Для товарных знаков, написанных заглавными или строчными буквами, используйте начальную заглавную букву, как это принято для имен собственных в английском языке. Например, Unix вместо UNIX. Нет причин объяснять это в каждой статье.

Избегайте типичных ошибок [ править ]

Помните, чем Википедия не является . Поскольку это не словарь, для каждого термина или продукта не всегда есть отдельная статья. Часто они объединяются в темы, которые могут стать предметом одной высококачественной энциклопедической статьи.

Каталог продуктов [ править ]

Статья о продукте должна включать историю его развития и основных улучшений. Но, поскольку Википедия не является каталогом и не является неизбирательной , избегайте полной пошаговой записи каждого выпуска или обновления. В отношении уровня детализации необходимо руководствоваться здравым смыслом.

Не вставляйте просто списки функций в статью, поскольку они могут устареть или удалены как реклама или нарушение авторских прав. Избегайте ссылок на относительное время (например, «в настоящее время», «в последнее время» или «сейчас»).

Версия по сравнению с названием продукта [ править ]

Каждая версия программного продукта должна иметь наиболее распространенное название .

Поставщики программного обеспечения часто используют один из следующих подходов для обозначения конкретной версии программного продукта:

1. Они включают номер версии в своем справочнике, например WinRAR 4 , WinRAR версии 3 и WinRAR v2 .
2. Они меняют название продукта с каждым выпуском, например Windows Vista и Windows 7 .

Видеоигры добавляют изюминку в эту схему. Продавцы видеоигр часто делают сиквелы и приквелы для своих самых известных продуктов. Они используют числа в названиях видеоигр, чтобы показать свои отношения. Например, Red Alert 2 и Red Alert 3 - две разные, но связанные видеоигры. Однако номера, входящие в заголовок, не являются номерами версий. По-прежнему можно использовать отдельный номер версии. Например, Red Alert 2 v1.008 - это обновленная версия Red Alert 2 .

Последовательно используйте наиболее распространенное название продукта. Например, используйте Windows XP , а не Windows v5.1 или Windows NT v5.1 . Не путайте и не комбинируйте эти методы, например, никогда не используйте Red Alert v2 или Red Alert версии 2 для ссылки на Red Alert 2 . Не придумывайте новые короткие формы и сокращения.

Пакет обновления [ править ]

Пакеты обновлений или выпуски обновлений - это компьютерные программы, которые модифицируют другое программное обеспечение для исправления ошибок или улучшения их. Обращаясь к пакетам обновления, делайте правильное различие между версией программного продукта, который обслуживается с помощью пакета обновления, и самим пакетом обновления .

Чтобы обратиться к пакету обновления, запишите полное название пакета обновления. Например:

• Пакет обновления 2 для Windows XP
• WinZip 9, сервисный выпуск 1

Чтобы обратиться к программному продукту, обновленному с помощью пакета обновления, напишите: [Название продукта] с [Название пакета обновления]. Например:

• Windows XP с пакетом обновления 2
• WinZip 9 с сервисным выпуском 1

В качестве альтернативы, если применимо, вы можете указать идентификатор версии программного продукта для краткости. Например:

• Windows XP с пакетом обновления 2 (SP2)
• WinZip 9 SR-1

Старайтесь последовательно использовать только один из этих двух стилей во всей прозе статьи. Использование обеих форм может сбить с толку читателей с небольшими техническими знаниями, поскольку они могут не понимать, что обе формы относятся к одному и тому же объекту. Однако, если обе формы часто используются в основных средствах массовой информации (как в случае с пакетами обновления Microsoft Windows), статья должна представить обе формы и установить их взаимосвязь, прежде чем последовательно использовать одну.

x86 против IA-32 [ править ]

Будьте осторожны при использовании термина « x86 », потому что он может вызвать двусмысленность. x86 - это тип ЦП, впервые разработанный Intel , а затем и другими. Широко используются два разных варианта x86: IA-32 и x86-64 . Однако из-за преобладания IA-32 термин «x86» часто используется для обозначения IA-32 посредством метонимии . Следовательно, эти термины следует использовать с осторожностью.

32-битные и 64-битные [ править ]

Не используйте термины « 32-разрядный », « 64-разрядный » или другие подобные термины длины в битах для обозначения архитектуры компьютера, процессора или программного обеспечения. Эти термины слишком расплывчаты и могут вызвать много двусмысленности или дезинформации.

Эти термины часто используются для обозначения двух хорошо известных типов архитектуры ЦП: IA-32 (32-разрядный вариант x86 ) и x64 (64-разрядный вариант x86). Однако ни IA-32 не является единственной 32-битной архитектурой ЦП в мире, ни x64 не является единственной доступной 64-битной архитектурой ЦП.

Пример правильного использования:

• «Это программное приложение работает только на процессорах x64».
• «Версия этого продукта для IA-64 [...]»
• «Сборка .z80 создана специально для Zilog Z80 и совместимых процессоров [...]»

Примеры неправильного использования:

• «Это программное приложение работает только на 64-битных процессорах».
• «32-разрядная версия этого продукта [...]»

Linux против GNU / Linux [ править ]

Используйте « Linux » вместо «GNU / Linux» для обозначения семейства операционных систем, основанных на ядре Linux . Термин «GNU / Linux» все еще может быть написан как часть собственных имен отдельных операционных систем и дистрибутивов Linux .

Именования полемика GNU / Linux существует, и «GNU / Linux» это имя , за которую выступает Фонд свободного программного обеспечения (FSF). Википедия, однако, отдает предпочтение наиболее часто используемому имени (что определяется по его распространенности в надежных англоязычных источниках ). Консенсус дискуссий в Talk: Linux / Name состоит в том, что точка зрения FSF не является общепринятым англоязычным использованием.

Забытые источники [ править ]

В Википедии все нуждается в источниках, включая, помимо прочего, даты выпуска программного обеспечения, размеры пакетов программного обеспечения, названия и количество поддерживаемых языков, а также языки программирования, используемые для разработки программных продуктов. Избегайте любых утверждений без ссылок, включая, помимо прочего, «многоязычные», «написанные на C ++» или «разработанные для Windows».

Совместное использование [ править ]

Избегайте использования странных форм языка. Напротив, редакторы должны придерживаться наиболее часто используемых форм, чтобы читатели чувствовали себя как дома. Не используйте синонимы определенных слов только потому, что они синонимы; коллокация очень важна.

Например:

1. Компьютерные программы, которые больше не разрабатываются, называются «брошенными» . Не используйте слова «забытое ПО» или такие новые термины. (См. Заброшенное ПО )
2. Акт прекращения разработки программного продукта называется «прекращением» . Не используйте «оставление» или аналогичные чужие термины. (См. Цикл выпуска программного обеспечения и окончание срока службы (продукт) )
3. Компьютерные программы работают на определенной операционной системе или платформе. Не используйте « бегать под » или « бегать под ».
4. Компьютерные программы работают в контексте или в контексте о наличии учетной записи пользователя . Не используйте « под », « внизу », « на », « внутри » или « над ». Хотя эти вариации могут быть приемлемыми в неформальной речи, Википедия: критерии избранных статей требуют использования профессионального стиля.
5. « Войти », « Войти » и « Войти » - все это глаголы, которые означают «предоставить учетные данные для аутентификации». Однако пользователи либо « входят в свои компьютеры », либо « входят в свои компьютеры ». Они никогда не « входят в свои компьютеры ». «Вход» используется только для аутентификации через Интернет. ^[a] (см. логин )
6. И « диск », и « диск » относятся к цифровым носителям информации. Однако «диск» совмещается с оптическим носителем, как на компакт-диске и диске Blu-ray , а «диск» совмещается с магнитным носителем, как на жестком диске или гибком диске .

Напряженный [ править ]

Всегда используйте настоящее время для глаголов, которые описывают жанры, типы и классы, даже если предмет описания (например, программа, библиотека, устройство) больше не существует, прекращен или не поддерживается / не поддерживается.

Следующий пример неверен:

• TrueCrypt - это программа для шифрования дисков, выпущенная TrueCrypt Foundation.

Это предложение предполагает, что TrueCrypt не является программой для шифрования дисков, хотя раньше она была. (Предположим, TrueCrypt никогда не менял своей природы в течение жизненного цикла разработки.) Грамматическое удаление скрывает тот факт, что в этом предложении есть два глагола «быть»; Однако более неуловимым фактом является то, что эти два глагола «быть» грамматически различны: первый - это глагол состояния , который не меняется на протяжении всего времени, в то время как второй - динамический глагол, который может перестать быть действительным по прошествии некоторого времени, когда прекращение происходит.

Используйте любой из следующих вариантов, в зависимости от того, что вам больше подходит:

• TrueCrypt - это программа для шифрования дисков, поддержка которой прекращена. Он был выпущен TrueCrypt Foundation.
• TrueCrypt - это программа для шифрования дисков, выпущенная TrueCrypt Foundation.

Необязательные стили [ править ]

Арбитражный комитет постановил , что редактора не должны изменить статью из одного основных положения определенного стиля к другому без уважительной причины , не связанной с простым выбором стиля. Возврат к конфликту из-за необязательных стилей недопустим. ^{[b] В} случае разногласий по поводу того, какой из стилей использовать в статье, сохраняйте статус-кво .

Следовательно, избегайте споров по поводу:

• Выбор одного из множества синонимов для понятия, например, «условно-бесплатная», «пробная версия» или другие синонимы; «x64» или «x86-64»; «проприетарное программное обеспечение» или «с закрытым исходным кодом»
• Использование одного или нескольких слов для обозначения одного и того же понятия, например «x86» или «IA-32 и x64».
• Порядок сортировки по возрастанию или убыванию
• Вставка одного из нескольких URL-адресов, которые указывают на одно и то же место, и ни один из них не имеет преимуществ перед другим.
• Любые другие множественные формы одного и того же

Скриншоты программного обеспечения [ править ]

Элементы командной строки [ править ]

В этом разделе изложены рекомендации по включению элементов терминалов или интерпретаторов командной строки в статьи Википедии, включая синтаксис команд или программ оболочки .

Общие правила [ править ]

• Предоставляя примеры командной строки или обсуждая элементы командной строки, сохраняйте ясность и простоту.
• Элементы командной строки должны быть представлены моноширинным шрифтом . Для встроенных ссылок используйте <code>...</code>пару тегов. В случае представления нескольких строк кода командной строки либо префикс каждой строки пробелом, либо заключите их все в <pre>...</pre>пару тегов.
• Избегайте ссылок на переменные среды , даты, рабочие каталоги , имена пользователей и имена хостов, если они не имеют отношения к примеру.
• Придерживайтесь следующей терминологии:
  • Вариант или переключатель является то , что модифицирует общее поведение команды.
  • Параметр представляет собой значение , конкретное, например, имя файла или имя хоста.
  • Аргумент является любым набором символов , которые следуют за именем команды, в том числе обоих вариантов и параметров. См. Параметр (вычисление) § Параметры и аргументы .
• Представляя аргументы, сохраняйте простоту; уточняйте их только при необходимости и с четкими пояснениями. Помните, что Википедия не заменяет справочные страницы . Не документируйте весь список параметров, связанных с командой, если такая наглядность не имеет энциклопедических целей .
• Укажите заполнители параметров, выделив логические имена курсивом. Эти имена не должны содержать пробелов, поскольку пробелы используются для разделения нескольких аргументов в командной строке. Вот несколько примеров:
  • (prompt) command parameter-name
  • (prompt) command ParameterName
  • (prompt) command parameter_name
  • (prompt) command parametername
• Заключите необязательные аргументы в квадратные скобки: [и].
• Задайте повторяющиеся параметры, используя один из следующих стилей:
  • (prompt) command parameter0 [.. parameterN]
  • (prompt) command [parameter ...]
• Ревностно поддерживайте последовательность в применении дополнительных стилей, описанных выше, для всей статьи.

Рекомендации для конкретных платформ [ править ]

Microsoft Windows [ править ]

Наиболее распространенной настольной операционной системой, используемой сегодня, является Microsoft Windows , синтаксис командной строки которой когда-то был основан на синтаксисе MS-DOS и OS / 2 ; Однако с ростом популярности Windows PowerShell стиль переместился в сторону Unix-подобных систем и языков программирования. Таким образом, придерживайтесь рекомендаций DOS и OS / 2 для элементов командной строки и примеров командной строки и консоли восстановления . Однако в случае Windows PowerShell соблюдайте приведенные ниже рекомендации для Unix-подобных систем и Windows PowerShell .

CP / M, DOS и OS / 2 [ править ]

Следующие дополнительные рекомендации относятся к примерам командной строки для семейств операционных систем CP / M , DOS и OS / 2 :

• Запишите имена внутренних или внешних команд, имена файлов и каталогов (если они соответствуют схеме 8.3 ) и имена переменных среды заглавными буквами (например DIR, AUTOEXEC.BATили %PROMPT%).
  • Примечание. Как упоминалось в начале этого раздела, это правило применяется только к примерам командной строки. Для использования заглавных букв в остальной части прозы и в заголовке статьи см. Википедия: Руководство по стилю / заглавным буквам § Все заглавные буквы и Википедия: Заголовки статей § Используйте обычно узнаваемые имена .
• Хотя в принципе DOS и OS / 2 (и Windows) поддерживают как обратную косую черту ( \), так и прямую косую черту ( /) в качестве разделителя для каталогов, некоторые программы (включая большинство оболочек в их конфигурации по умолчанию) поддерживают только обратную косую черту. Поэтому используйте обратную косую черту в примерах путей к каталогам на локальных томах, если не важно указать иное.
• Различные системы DOS поддерживают настраиваемый пользователем SwitChar (обычно либо косую черту ( /), либо дефис-минус ( -)), но не все программы его придерживаются. Поэтому, если программа поддерживает это, используйте /в примерах значение по умолчанию , если не важно указать иное.
• Стандартные параметры (в форме /Cили -C, если Cэто какой-то символ) также должны быть в верхнем регистре, если они не чувствительны к регистру.
• Сравните имена программ с именами встроенных команд, добавив к ним расширение файла . Если программа не входит в состав определенных версий (например, XCOPY.EXEили EDIT.COM), то должны быть указаны версии, для которых она, как известно, включена.

Unix-подобные системы и Windows PowerShell [ править ]

• Встроенные команды и командлеты оболочки (например, cd и history ) должны быть обозначены как таковые.
• По возможности избегайте команд или утилит, специфичных для оболочки (таких как цикл for или определенные поведения потока), из-за большого разнообразия оболочек в Unix-подобных системах. Если последовательность оболочки конкретная требуется для правильного объяснения, дает пример для алгола -подобных оболочек ( Bourne оболочки , оболочки Korn и Bash ), а также один для C -подобного синтаксиса C оболочки и Tcsh .
• Соблюдайте требования оболочки к регистру символов. Имена большинства команд в Unix-подобных системах полностью написаны строчными буквами, в то время как оболочка и операционная среда чувствительны к регистру. Windows PowerShell не чувствителен к регистру; поэтому пишите имена командлетов в их естественной английской форме, чтобы облегчить чтение и запоминание. Пишите псевдонимы, производные от Unix (например, ls и cp ), в нижнем регистре. При необходимости используйте заголовок в нижнем регистре или шаблон с неправильным заголовком .
• Разграничивайте команды, которые обычно требуют привилегированного доступа, от команд, которые этого не требуют.
• В некоторых случаях значение параметра обычно содержит метасимволы оболочки . В этих случаях может быть разумным указать в примере цитирование, чтобы пользователи не получали ошибок, которые будут казаться им странными и несвязанными.
• Всегда указывайте минимальный (и, если применимо, максимальный) номер версии оболочки, поддерживающей команду. Linux (в связи с его природой с открытым исходным кодом) и Windows PowerShell могут вводить новые команды в любое время.

Предоставление образца вывода [ править ]

Часто бывает полезно предоставить образец вывода, который генерирует команда. В этих случаях указывается полная команда и все аргументы в том виде, в каком они были введены. Таким образом, вывод команды будет зависеть от среды и других переменных. Теги <pre>...</pre>, <nowiki>...</nowiki>и <SyntaxHighlight>...</SyntaxHighlight>(с соответствующими аргументами) предотвратить конфликты с вики - разметки синтаксиса.

Примеры использования [ править ]

Примеры DOS [ править ]

DIR встроенной команды на DOS, которая выводит список файлы и каталоги:

> DIR [ параметры ] [ шаблон ...]

Программа MOVE.EXE для MS-DOS, поведение которой необходимо было эмулировать до ее внедрения:

> MOVE.EXE источник  целевого

Примеры Unix [ править ]

Команда ls в Unix-подобных системах, которая выводит список файлов и каталогов:

$ ls [ параметры ] [ файл ...]

Команда mkfs , которая создает новые файловые системы и поэтому обычно требует привилегированного доступа:

# mkfs [-t fstype ] [ fs-options ] устройство

Программа wget , одна из утилит GNU , которая извлекает файлы по унифицированному идентификатору ресурса (URI). URI иногда могут содержать метасимволы оболочки, поэтому для предотвращения ошибок параметр обычно указывается в кавычках.

$ wget [ параметры ] " URI "

, Если встроенная структура, синтаксис которого изменяется. В оболочке Bourne, оболочке Korn и Bash:

$ if command  ; затем команда  ; ...; фи

В оболочке C и tcsh :

% if ( выражение ) then command  ; ...; endif

Пример вывода команды df , в которой перечислено использование дискового пространства в смонтированных файловых системах :

$ df -P Файловая система Используется 512 блоков Доступная емкость Установлена ​​на / dev / hda2 39331760 7398904 29834768 20% /

Лицензия [ править ]

Постарайтесь точно и лаконично указать условия лицензирования предмета статьи о программе для ЭВМ.

В лицензионных соглашениях обычно указывается одно или несколько из следующего:

1. Среда использования (например, коммерческая, некоммерческая, личная, образовательная, не военная и т. Д.)
2. Стоимость использования (например, бесплатно, единовременно, по подписке и т. Д.)
3. Применимые лицензиаты (например, неограниченные, один компьютер, одна учетная запись пользователя компьютера, один пользователь, корпоративное лицензирование и т. Д.)
4. Другие права (например, право на исследования, модифицировать, декомпилировать и т.д.) или ограничение (например , использование для производства порнографического содержания)

В Википедии есть статьи о наиболее распространенных схемах лицензирования программного обеспечения. Таким образом, в большинстве случаев схему лицензирования можно описать одним или двумя словами вики-ссылки в информационном окне. Например, GPL , Freemium , лицензия BSD или проприетарное коммерческое программное обеспечение (напишите: [[Собственное программное обеспечение | Собственное программное обеспечение]] [[коммерческое программное обеспечение]]) . Избегайте расплывчатых или совершенно неинформативных фраз, таких как « Лицензионное соглашение поставщика » , «Несколько» и «Неизвестно» .

Адреса веб-сайтов [ править ]

Открытые URL [ править ]

Некоторые области Википедии, такие как информационные блоки, требуют, чтобы адреса веб-сайтов (URL) отображались в печати. Для обеспечения удобочитаемости и краткости некоторые части веб-адресов, возможно, потребуется скрыть или использовать их более короткие формы.

Веб-адрес состоит из нескольких частей, в следующих примерах показаны некоторые из наиболее часто встречающихся:

Однако читателю не нужно видеть все эти несколько непривлекательные и трудно запоминающиеся элементы, благодаря способности веб-браузеров и веб-серверов делать выводы о них. Часто следующие части могут быть опущены:

1. Схема : опускать http://в отображаемом URL-адресе, но не в базовой ссылке; шаблон скрывает эту схему автоматически. Остальные схемы нравятся и нужно останавливаться.{{URL}}https://ftp://
2. Запрос : если часть запроса состоит только из одного символа косой черты ( /), опустите его; шаблон скрывает это автоматически. Пользователи часто опускают одиночный символ косой черты как единственную спецификацию запроса и ожидают, что URL-адрес будет работать правильно.{{URL}}

Упущение санкционировано только в том случае, если функциональность не нарушена. Всегда проверяйте полученный URL. В тех редких случаях, www.или /требуется, рекомендуется , чтобы оставить комментарий невидимый вики-разметки для уведомления будущих редакторов.

Если поставщик целевого веб-сайта предоставил более короткие альтернативные URL-адреса для веб-страницы, используйте их. Единственным исключением из этого случая являются короткие URL-адреса, в которых используются трудно запоминаемые числа. Например:

Не используйте URL - адрес укорочение услуги , такие как bit.ly . Такие URL-адреса поддерживаются независимыми организациями и подвержены гниению ссылок . (См. Также: сокращение URL § Недостатки )

Выбор между HTTP и HTTPS [ править ]

В случае, если связанный веб-сайт обслуживает контент по протоколам HTTP и HTTPS , т. Е. Принимает URL-адреса с обоими схемами http://и, https://обратите внимание на следующее: ^[c]

• Используйте https://схему для сайтов, которые обслуживают контент только через HTTPS или поддерживают как HTTPS, так и HTTP. Сюда также входят веб-сайты, которые принимают http://адреса, но перенаправляют их на https://.
• Используйте http://схему для сайтов, которые вообще не поддерживают HTTPS.
• Википедия раньше использовала относительные ссылки протокола для сайтов, поддерживающих как HTTP, так и HTTPS (например: //example.com/ вместо https://example.com/ или http://example.com/ ). Однако, поскольку сама Википедия теперь требует HTTPS, он устарел.

См. Также [ править ]

• ВикиПроект Информатика / Руководство по стилю (черновик)
• Википедия: Руководство по стилям / датам и числам § Нотации не по основанию 10

Заметки [ править ]