Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Задокументировать формы отчетов.
 
Поделитесь опытом.

Есть программный продукт, при работе с которым можно мнооого разных отчетов навыгружать. Хотелось бы все формы задокументировать.

Приходилось ли Вам такой документ собирать?
Может даже есть указания какие-нибудь на подобного рода документы и они как-то официально называются?
 
Зачем?
 
:D  Хвастаться перед потенциальными пользователями.
 
Мы документируем все формы отчетов. Если вкратце - для каждого элемента отчета подробно описывается, в каком месте системы вводятся данные, которые идут в эту ячейку, или алгоритм расчета значений. Зачем? Чтобы алгоритм построения отчета был прозрачным для пользователя. Дать пользователю возможность убедиться в корректности выводимых данных. Ну и идея, понятно, тоже принадлежит пользователям )
Работать надо не 12 часов, а головой.
 
Алгоритм построения отчета прозрачным для пользователя???


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


Отправлено с SONY Xperia Z
 
С анекдотами идея интересная - возьму на заметку ) К сожалению, это пользователь платит нам деньги за разработку, а не наоборот. Так что, если он хочет методики формирования отчетов - он их получает. Не вижу ничего плохого в том, что пользователь понимает, как функционирует система, для этого мы и работаем.
Работать надо не 12 часов, а головой.
 
Ну если только платят конкретно за это.

А вообще пилоту воздушнооо судна не нужно знать как устроены двигатели или шасси.
 
Ну Вы такие примеры приводите) Мне, как водителю, интересно знать, как устроена коробка передач, чтобы грамотно ей пользоваться (вангую обсуждение авто с АКПП).
Особенно когда дело касается финансовой отчетности, всем интересно, откуда взялась пара лишних миллионов в платежке)  
Работать надо не 12 часов, а головой.
 
Налоговой интересно, а пользователю хз. Бухгалтеру походу абсолютно пофиг как "эта дрянь" работает. У бухгалтера есть калькулятор и эксель для проверки. Даже если он будет знать алгоритм и в ИТОГО будут расхождения, он не полезет в код исправлять ошибку. Для этого есть разработчики, тестировщики и аналитики.

А разработчик должен правильно написать алгоритм, основываясь на ТЗ
 
И знать устк ройство АКПП для правильной эксплуатации автомобиля не нужно. Для этого есть руководство по эксплуатации.

Вод.стаж 12 лет, ни разу не лез внутрь. Более того, мне это запрещал и не рекомендовал производитель. В случае неисправности -> тех.центр.

В вашем случае -> на тестирование и доработку
Изменено: ADVANCED - 11.04.2014 11:44:44
 
Цитата
Nadufka пишет:
Мне, как водителю, интересно знать, как устроена коробка передач,
Интересно, но не необходимо.  это бесполезная информация "как водителю"


Все интересы никогда не опишутся. Так что
что если платят за это, то нужно делать. Если нет, то нет  ;)  разные "хотелось бы" вас засосут по самое не балуй :)).
Изменено: ADVANCED - 11.04.2014 11:59:37
 
Ну я и имела ввиду, что коробка механическая, а не автомат, поэтому хочешь-не хочешь, а общие принципы знай)
А алгоритм - он на то и алгоритм, чтобы бухгалтер знал, какие цифры и значки на калькуляторе набрать, чтобы проверить. И если в ИТОГО будут расхождения, он, конечно, обратится в службу ТП с запросом. И сделает этого до того, как налоговой станет интересно =)
Работать надо не 12 часов, а головой.
 
Далее. Все мы, конечно, представляем себе сферическую систему в вакууме, где пользователь вводит все исходные данные по таймеру. В жизни имеем огромную систему, и кадровик не полезет в платежки, а бухгалтер в штатку (к примеру) не только потому, что ему не платят за это, но и потому что правами запрещено. А увидев прочерки в отчетности, один пользователь может просто не понять, у какого из 100500 других не сработал таймер на ввод данных.
Все индивидуально. И чем лучше сработает технический писатель, тем больше он разгрузит службу техподдержки.
Изменено: Nadufka - 11.04.2014 12:26:46
Работать надо не 12 часов, а головой.
 
Спасибо.
 
Цитата
Nadufka пишет:
И чем лучше сработает технический писатель, тем больше он разгрузит службу техподдержки.
Категорически не согласен. Если разработчик хорошо напишет, то писатель будет не нужен и тех поддержка тоже

А для разработки нужно нормальное тз и тестировагие
 
Если не делить мир на черное и белое, правы мы оба.

Цитата
TechW пишет:
Спасибо.
О Вас-то мы и забыли) Вы спрашивайте, если что)))
Работать надо не 12 часов, а головой.
 
Цитата
Nadufka пишет:
Если не делить мир на черное и белое, правы мы оба.
Ну... по нормам этикета и хорошего поведения я должен согласиться. НО! TechW обратился за помощью и советом. Ему\ей "хотелось бы" описать отчеты. Имея опыт разработки технической документации более 2 недель, сталкивался с такими желаниями и потребностями неоднократно.   ;)  

1. Эта информация не несет никакой ценности. Максимум 1 человек ее прочтет в туалете.
2. Ничего плохого нет в описании алгоритма работы, на который никто никак не повлияет, кроме разработчиков. Это просто убитое время, затраченные силы и т.п. Когда будет нехватка времени, начальство будет потакать каждый раз за то, что не описан новый отчет, назад дороги не будет Начал - делай до конца.
3. Касаемо п.2.  - лучше описывать не как считается та или иная сумма в ячейке, а что в какую ячейку\поле надо вводить чтобы все работало правильно. Изменения в законодательстве должен отслеживать специально обученный персонал, дорабатывать разработчик, проверять тестировщик или постановщик задачи. Форма ввода может не меняться, а  алгоритм может. Вы, простите, при каждой поправке статьи закона будете менять описание ? Смысл?  

У нас летнее\зимнее время постоянно меняется. Проще написать, как поставить галочку "автоматический переход", чем раз в полгода обновлять все инструкции.


4. Надо еще вспомнить где и что поменять в описании, при изменении формы отчета. Это также большой и бесполезный труд.
Изменено: ADVANCED - 12.04.2014 22:04:10
 
Цитата
TechW пишет:
Хвастаться перед потенциальными пользователями.
А если при изменении формы вы забудете или продинамите исправления, чем будете хвастаться? Документация будет неактуальна и пользователи узнав об этом в лучшем случае будут её игнорировать, в худшем hh.ru.
На мой взгляд это добровольная инициация проблем СЕБЕ (кроме частных случаев, когда конкретно за это платят деньги).

Если есть сомнения, уточните у продакт-менеджера или разработчиков и обязательно отпишитесь тут. Много мнений хорошо.
Изменено: ADVANCED - 12.04.2014 22:02:02
 
Ну что ж, конкретно в моем случае смысл в этой процедуре есть. По поводу того, что операция эта трудоемка и времязатратна - соглашусь. Если есть возможность избежать этого - избегаем. Но в тех системах, для которых описания реализованы, результат заметен и для нас, и для пользователя (который за это платит деньги). Писать или не писать - каждый решает сам, плюсы и минусы - выше.
ADVANCED - спасибо за дискуссию =)
Работать надо не 12 часов, а головой.
Страницы: 1
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить картинки
Отправить Отменить