Поиск  Правила  Войти
The Bat! почтовый клиент для Windows » Настройка и конфигурирование
Страницы: 1
RSS
Документирование-труд, но труд необходимый., Руководство пользователя
 
#1
0  
Добрый день всем.
У меня проблема с получением документации, которая исходит из того, что все разработчики ПП стран СНГ так и не определились с написанием документации.
Каждое руководство пользователя должно содержать примерно следующее согласно приведенным ниже стандартам:
тексты сообщений, выдаваемых в ходе (настройки, проверки, выполнения) программы, описание содержания, описание действий, которые необходимо предпринять по этим сообщениям
ГОСТ 19.402-78
ГОСТ 19.502-78
ГОСТ 19.503-79
ГОСТ 19.504-79
ГОСТ 19.505-79
IEEE Std 1063-2001
Уважаемые коллеги, а что же делать с лог файлом или "Журналом работы" как понять текст тех или иных записей. Что делать если данная запись появилась. Ответ нигде я так и не нашёл. И именно по этому обращаюсь к вам. Может вы подскажите, ведь это не единственное чего до сих пор нет.
Спасибо за внимание!
 
 
 
#2
0  
Хелп - это достаточно больная тема :(
Для меня главное в хелпе - это документация возможностей, интерфейса и настроек.
По поводу сообщений в журнале - описание этого вещь совершенно малореальная, так как мыш показывает в журнале по большей части то, что ему отвечают сервера.
А сервера - они разные и неохватываемы разработчиками мыша по определению.
Это касается как SMTP серверов, так и POP3 серверов.

Примерно то же можно сказать о возвращаемых оправителю письмах (например: неудачная доставка).
 
 
 
#3
0  
По поводу лог-файла (except.log) - его основное назначение - это пересылка цитат из него в саппорт или разработчикам в случае ошибок в программе.  Никакой другой реакции на него не подразумевается, насколько я понимаю.
 
 
 
#4
0  
Диалог или "Борьба" пользователя и "Журнала работы"
Давайте исключим "Журнала работы" из пользовательского интерфейса исходя из выше сказанного.

/*-По поводу лог-файла (except.log) - его основное назначение - это пересылка цитат из него в саппорт или разработчикам в случае ошибок в программе. Никакой другой реакции на него не подразумевается, насколько я понимаю.----*/


Приведу следующий пример.
на любом поисковике необходимо набрать "Журнал работы и The Bat!"
И откроется подобная ситуация.Поиск занял примерно 20 секунд.
Идите по ссылке. http://www.nestor.minsk.by/kg/help/2005/06/010101.html
Значит "Журнал работы" это очень важный элемент, но что делать и как делать мы так до сих пор не выяснили. И долго ли, если не всегда мы будем получать ответы от третьей стороны на достаточно простые с точки зрения администраторов,но достаточно концептуально сложные для пользователей вопросы. Говоря об этом элементе программы думаю, что для меня уже было бы проще если бы была хотя бы классификация поступающей в журнал работы информация:
лог файл пользователя
         Запись производится
        при авторизации
                        содержание
                            .....
        при отправки письма
                        содержание
                          .......
        при получении письма
                        содержание
                           ......
        при работе программы и возникновении ошибок
                        содержание
                           ......

С соответствующей формой отображения.
Ведь это уже что-то.
Документирование-труд, но труд необходимый!
 
 
 
#5
0  
Цитата
Документирование-труд, но труд необходимый!
Я только за!
Майкрософт уверяет, что на шестерых разработчиков должно быть 2 писателя.

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

Что именно предлагается вами я не очень понял.
Предлагается писать журнал линейно, а показывать нелинейно с группировками?
 
 
 
#6
0  
Вы ушли от главного.

/* И долго ли, если не всегда мы будем получать ответы от третьей стороны на достаточно простые с точки зрения администраторов,но достаточно концептуально сложные для пользователей вопросы.*/

Что касается журнала работы, то для начала я бы вёл некоторые изменения во временную последовательную линейную структуру отображения.

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

а что это;
а что им можно делать;
а что им нельзя делать;
а что надо, чтобы оно работало;
а что там у него внутри (у особо пытливых);
а как его настроить;
а как его проверить, работает оно или не работает;
а что и где надо нажимать;
а что оно еще может делать;
а что оно говорит, если что-то не так нажимаешь?

Существующую структуру оставил.
Но. Не в качестве базовой. А как одну из форм представления. Так например Я хочу узнать кому за сегодня я отправил сообщения форма№1,от кого я получил сообщения форма№2,как устойчиво работала моя программа форма№3 и т.д. согласно выделенным функционалам.  
 
 
 
Страницы: 1