Мы создаем справку вместе
Смысл темы: сбор информации для новой справки по QSP, AeroQSP. (частично Qgen и TXT2GAM)
+ Вы - описываете в сообщении любую функцию, оператор так, как хотели бы увидеть в справке. Опишите с той глубиной пояснения, которую считаете нужным. Будь это три строки или сообщение, занимающее всю область экрана.
+ Стиль описания выбираете сами. Это и сухой-программерский, философско-рассуждающий или в стиле, в котором пишете свои рассказы. Пишите как для самого себя.
+ Добавьте примеры кода, которые используете взамен несуществующих функций в QSP.
+ Дублировать информацию из чужих постов - можно. Пытаться передать иными словами сказанное - можно.
= Все наработки позже будут рассмотрены энтузиастами и приведены в единый стиль с логичной структурой. Может получиться дублирующая справка, но написанная понятным языком для обычных пользователей. С той степенью разжеванности и тем количеством примеров, которые необходимы для понимания.
Шаблон описания:
Имя функции, оператора или термина. (Это тэг, который поможет Сшивателю справки)
Ваше описание. Один термин - одно сообщение (Все для удобства Мистического Сшивателя)
Пожелания:
+ Поселиться здесь вместо темы “набивание сообщений”.
+ Воздержаться от обсуждения чужого поста. (Мистическому Сшивателю сложно разобраться в спорах, но проще в шаблонных сообщениях.)
+ Пишите так, будто в предыдущих постах ничего не было сказано о том, о чем хотите сейчас поведать.
+ Юмор уместен только внутри шаблона.
+ Это будет постоянно всплывающей темой, мозолящей глаза, и мы в конце-концов сделаем справку.
Martin Doriel:
Поселиться здесь вместо темы “набивание сообщений”.
Не-а, гы
Насколько текущая справка плоха кроме формы изложения?
В первую очередь, структура справки неправильная, непонятно где что искать. Нужно организовать ее по функционалу, причем так чтобы это было понятно не-программисту.
Вот у нас сейчас например оглавление:
“Операторы и функции”
“>Выражения”
“>Операторы”
“>Функции”
“>Системные переменные”
Ни одного слова не понятно, тем кто с программированием не сталкивался. Где мне искать вывод строки на экран? В операторах? А может в функциях? Или это относится к выражениям? Только программисту ответ кажется очевидным, для остальных это вопрос непростой. Сделать разделы “Оформление”(”Графика”, “Звук”, “Настройка интерфейса”), “Вывод текста”, “Условия”, “Переходы”, “Предметы”, “Действия” - уже будет понятнее. Структуру нужно очень хорошо продумать, досконально. Неудобная и непонятная справка практически бесполезна.
Старую “программистскую” структуру при желании можно оставить альтернативной веткой, где-нибудь в первых пунктах верхнего уровня, чтобы не мешалась.
Старая структура тоже не очень - о чём я и говорил. Но помоему рассчитывать только на неопытных новичков не стоит и всё равно с неё придётся начинать: сначала про то как складывать числа и использовать строки, потом про условия, а затем уже можно и к предметам переходить (это вкрадце).