Как стать автором
Поиск
Написать публикацию
Обновить

Говорим на одном языке: как стандартизировать стиль документации

Время на прочтение5 мин
Количество просмотров2.7K
Всего голосов 4: ↑4 и ↓0+6
Комментарии7

Комментарии 7

А я то, простофиля, раньше думал, что для этого предназначен ГОСТ Р 2.105—2019... Ну или на худой конец ГОСТ 19 серии... А оказывается чтобы стандартизировать стиль проектной документации эти книжки вообще не нужны...

ГОСТы, конечно, хороши для форматов и структуры, но когда речь идет о стиле, тут уже не обойтись без гибкости. ГОСТ Р 2.105—2019 и ГОСТ 19, конечно, задают основы для оформления документации, но стиль — это про тон, голос, восприятие и работу с пользователем. Для этого как раз и нужны внутренние руководства по стилю. В них прописывают все нюансы: от того, как обращаться к пользователю, до того, как правильно передавать идеи и чувства через текст. ГОСТы тут не помогут, да и не должны!

👍

В случае с Wi-Fi действительно существует несколько вариантов написания, но всё зависит от контекста. Если речь идет о торговой марке, то правильным будет именно Wi-Fi, как зарегистрированный товарный знак. В других случаях — когда это просто описание технологии или стандарта — можно использовать wifi (с маленькими буквами). Однако важно придерживаться единого стиля внутри документации, чтобы не запутать читателя. В некоторых компаниях принято всё-таки использовать Wi-Fi, даже в общем контексте, чтобы сохранить узнаваемость бренда. Главное — согласованность! 😉

Не уверен, что есть такая технология и такой стандарт — Wi-Fi. В неформальной речи — да, но не в технической. Технология называется wireless LAN (WLAN), стандарт — 802.11x.

Зарегистрируйтесь на Хабре, чтобы оставить комментарий