Он-лайн документация - напишем вместе!

[Alex]

Мне неоднократно писали, что помощь к программе крайне скудна и уже далеко не полна. На самом деле это правда. Сначала я просто не придавал большого значения написанию помощи и, добавляя функционал, не расширял документацию. Когда же я понял, что помощь крайне важна, переписывать нужно было уже практически все.

Вот такая стоит передо мной дилемма сейчас:
1. Продолжать добавлять функционал, не обращая внимания на документацию и рассчитывая, что программу будут использовать только очень понятливые люди.
2. Написать новую версию помощи к программе. При этом, если описывать по 3 действия в день, мне потребуется около 2,5 месяцев лишь на действия. Больше 3х действий в день описывать я не смогу, так как сейчас сильно ограничен во временных ресурсах (большая нагрузка на основной работе и маленький ребенок дома).

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

Если Вы хотите сказать "Спасибо" мне как создателю программы, то можете просто описать одно-два действия, это будет наилучшая благодарность.

Спасибо всем!

[AlexII]

Очень хочу сказать спасибо, давно хочу .
У меня мысль о справке вертелась, но тормозилась тем же — одному человеку трудно всё описать и особенно не отставать от воплощения идей.
Развернуть попутно Wiki не получится? Для коллективной работы будет получше, чем форум.Нашёл.

Я опубликовал полный список действий в специальном разделе форума

Хоть убейте, не вижу этого списка. Вижу два пустых подфорума в новом форуме Документация и всё. Плохо гляжу?

[Alex]

Сори, не проверил права на ветку Действия. Теперь должно все отображаться.
Wiki вроде бы развернута для xStartDesigner, но мне почему-то больше нравится форум. В дальнейшем планирую на основе ветки Документация создать .chm файл, это просто будет сделать, вытягивая тексты из базы данных. В случае в Wiki придется повозиться .

[AlexII]

Сори, не проверил права на ветку Действия. Теперь должно все отображаться.

ОК. Работает.

Wiki вроде бы развернута для xStartDesigner, но мне почему-то больше нравится форум. В дальнейшем планирую на основе ветки Документация создать .chm файл, это просто будет сделать, вытягивая тексты из базы данных. В случае в Wiki придется повозиться :).

Вроде бы есть инструменты для конвертации формата Wiki в HTML. И вообще, желательно дать ТЗ на оформление (или, может быть, ориентироваться на текущий стиль справки xStarter?). Впрочем, главное сейчас — начать.

[Alex]

Я уже описал два действия, можно ориентироваться на них:
viewtopic.php?f=71&t=740
viewtopic.php?f=71&t=741

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

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

Результирующие параметры - список параметров, доступных для использования как результатов выполнения действия.

На первом этапе этого вполне достаточно. На втором можно будет собирать информация в форуме с вопросами и ответами об использовании конкретных действий.

[aka_smile]

документация уже написана?

[Alex]

Нет.

[yarunya]

Работаем!