Foren / National / Russian / Русская документация

За последний год никто тут по wiki plugin об стенку головой не бился. А под седом 121 он точно работал.

# Gunslinger : 4. Описание входящих параметров
5. Возвращаемый результат.

Это содержится в блоке комментариев практически перед каждой функцией, правда на английском но всеравно достаточно просто понимаемо для програмиста.

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

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

Например мое текущее предложение следующее: Давай не будем сразу хвататься за все (как говорит мой дип. руководитель - слона едят по частям). Имеем чётко поставленную задачу

# Gunslinger : Может сваяем описание функций из functions.admin.php и functions.php в формате:
1. Название функции
2. Назначение
3. Основные нюансы работы функции.
4. Описание входящих параметров
5. Возвращаемый результат.

Хорошо пол дела сделано теперь выработаем план дальнейших действий по реализации. Но для начала нужно понять "КТО ГОТОВ РАБОТАТЬ?" (ну хоть по 5-10 мин. в день уделять задачке).

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

Далее каждый член группы активистов(и не только - разработчики тоже будут прикладывать свой труд в общее дело) по мере своих возможностей оформит хотя бы часть документа заготовки в удобочитаемом виде (ведь это одно из основных препятствий быстрому написанию документа).

Далее после того как документ обретет красивую форму начнется постепенный перевод на русский уже содержащейся информации.

Затем каждый кто разобрался в работе той или иной функции заполнит поля "Назначение " и "Основные нюансы работы функции" (Тут конечно болше нужно требовать от опытных пользователей). И так документ постепенно будет обретать завершенную форму справки по функциям.

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

Для тех кто ниасилил, что нужно?:

1. Собираемся
2. Стягиваем будущую инфу
3. Оформляем
4. Переводим
5. Дополняем
6. Проверяем
7. Гордимся собой .....