ubuntu-ru-wiki team mailing list archive

[Alexey Balmashnov <a.balmashnov@xxxxxxxxx>]

> 10 апреля 2009 г. 19:07 пользователь Неворотин Вадим <nevorotin@xxxxxxxxx>
> написал:
>>
>> В общем, почитав статьи, которые уже добавлены в вики, я обратил внимание
>> на совершенно разный стиль оформление разными редакторами. Это не есть гуд.
>> В связи с этим я набросал макументик по оформлению, предлагаю всем с ним
>> ознакомится и прокомментировать:
>>
>> http://wiki.ubuntu.ru/admin/стилистика_статей;
>>
>> На всякий случай: в выборе стилей для написания тех или иных вещей я
>> исходил из неиспользования подчёркивания и жирного шрифта, ибо это не
>> является хорошим стилем оформления.
>>
>> Особое внимание прошу обратить на случаи, в которых надо бы что-то
>> выделить, но которые не описаны в том документе.

Это хорошо, но там всё (или почти всё) по техническому оформлению.
Стиль это ведь не только техника, но и как подаётся информация.

Я думаю, нужно ещё пройтись по оформлению в смысле искоренения
конкретики (перенесения её в примеры), особенно в таких вещах, как
команды установки пакетов, команды редактирования текстовых файлов и
т.п., ибо, как известно, на вкус и цвет фломастеры разные, кто-то
пользуется apt-get и vim-ом, а кто-то кроме "текстового редактора" из
меню и synaptic-а ничего не знает.

Т.е., например, вместо:
Воспользуйтесь командой:
sudo apt-get install abc
чтобы установить пакет abc

Писать:
Установите пакет abc /и всё это ссылка на описание стандартных методов
установки/

Или
Установите пакет abc /и всё это ссылка на описание стандартных методов
установки/, например:
sudo apt-get install abc

Вместо:
vim /path/to/file

Отредактируйте /path/to/file (с возможным упоминанием про
необходимость мега-прав)

...

Вот тут ещё можно посмотреть на предмет "обмена опытом":
https://wiki.ubuntu.com/DocumentationTeam/StyleGuide