Size: a a a

technicalwriters

2021 June 23

BL

Bo Larson in technicalwriters
скобки имхо тоже

похоже имбометод - выделять болдом, а заголовки не лениться делать в стиле заголовков вместо просто выделения текста заголовка болдом
источник

AC

Alec Chakenov in technicalwriters
Большие и серьёзные ребята так делают :) Включая, наверное, Microsoft.
источник

V

Vlad in technicalwriters
источник

V

Vlad in technicalwriters
“Use bold formatting, <b> or **, for UI elements”
источник

JU

Jxhnny Ut8h in technicalwriters
Ну на небольшом доке норм, зависит от контекста
источник

AC

Alec Chakenov in technicalwriters
Скобки тоже не стоит использовать для оформления кнопок. У них другое предназначение. Ну и если видите какую-то фразу в скобках, то это повод - переписать предложение или разбить на два.
источник

AC

Alec Chakenov in technicalwriters
Серьёзных ребят от несерьезных можно отличить по стилю. У серьёзных всегда есть свой Style Guide.
источник

BF

Bobba Fett in technicalwriters
Если информация касается конкретной строки, столбца или ячейки, то нельзя. Пользователь найдёт нужные ему данные в таблице и никогда не узнает, что чего-то ещё про эти данные написано ПЕРЕД таблицей.
источник

AC

Alec Chakenov in technicalwriters
Посмотрел на скриншот. Cannot всегда пишется слитно и ID заглавными. Если оставите id - это будет уже совсем другое слово.
источник

BL

Bo Larson in technicalwriters
совсем другое - какое?
источник

AC

Alec Chakenov in technicalwriters
Id - это бессознательное.
источник

BL

Bo Larson in technicalwriters
donot получается тоже слитно по аналогии?
источник

BL

Bo Larson in technicalwriters
странная мысль, не догоняю
https://acronyms.thefreedictionary.com/ID
источник

AC

Alec Chakenov in technicalwriters
Там нет аналогий, нужно просто запомнить все слова, а также - являются они исчисляемыми или нет. От этого будет зависеть выбор артикля. В любой непонятной ситуации стоит сходить в словарь  macmillandictionary.com.
источник

BL

Bo Larson in technicalwriters
так not это же не артикль
источник

AC

Alec Chakenov in technicalwriters
источник

BL

Bo Larson in technicalwriters
ого! Интересно сколько людей про это знают, вангую, что крайне мало
источник

BF

Bobba Fett in technicalwriters
id Software же!
источник

BL

Bo Larson in technicalwriters
Это-то да, но всю жизнь был уверен, что у них айди в плане доков или айдишника было использовано там)
источник

BF

Bobba Fett in technicalwriters
Не увидел там cannot и id в текстах, но обратил внимание, что описания со строчных букв начинаются. Иногда предложения отделяются запятыми, А ещё приписки optional parameter (иногда an optional parameter) можно вынести в свою колонку или использовать те же самые сноски - это разгрузит текст описания и будет нагляднее бегло понять, что из перечисленного обязательное
источник