Описание постановок функций ПО

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru! 
@twriters
 obmen_soobsheniyami.pngчат для технических писателей в Telegram

 Зарегистрируйтесь
Страницы: 1
RSS
Описание постановок функций ПО, бестпрактикс и не только
 
Если у вас есть в загашнике универсальные шаблоны описания постановок различных функций ПО - делитесь ими в данной теме пожалуйста. Причем интересно как с точки зрения бизнес-анализа, так и системного. Под функциями ПО подразумеваю навроде: импорт, экспорт, синхронизация, формирование объекта, контроль, ввод данных, редактирование, хранение, статусная модель, экранная/списковая/печатная форма и тд и тп.
Шаблоны описаний функций рассматриваю в качестве первой ступени для аналитика.
Вторая ступень - определить критерии, по которым происходит выбор того или иного решения. Поясню, что имею в виду на примере импорт/экспорта - обмен данными может происходить по расписанию/по событию (переход со статуса на статус/по нажатию на кнопку пользователем/иное). Вот когда надо выбрать конкретный из вышеперечисленных способов, запускающих процесс обмена данными?! Критериями могут быть: 1) частота обновления данных в системе-источнике; 2) частота использования данных в системе-приемнике; 3) на стороне какой системы развернут веб-сервис.... иные критерии.

Какие еще  ступени развития аналитика можно выделить?
 
Универсальных шаблонов нет. Каждый использует какие-то свои, устоявшиеся со временем стандарты описания, подходящие под стилистику дока. Я как правило смотрю как пишется документация у других компаний, в интернете полно доков разных приложений с описаниями, и выбираю самые интересные. И следую правилу, что не надо описывать функции, надо описывать процедуры как их использовать.

+ есть рекомендации, множество книг (моя любимая How to write the f*cking manual (англоязычная))
вот к примеру недавний доклад про проблему документации https://github.com/docops-hq/conf/blob/master/highload/19/siberia/docs.md
Страницы: 1
Читают тему

Рейтинг@Mail.ru