Перейти к содержимому

Фотография

Написание "памятки" по проекту


  • Авторизуйтесь для ответа в теме
Сообщений в теме: 6

#1 selen

selen

    Активный участник

  • Members
  • PipPip
  • 102 сообщений
  • ФИО:Сергей

Отправлено 17 января 2019 - 12:02

Доброго всем.

Подскажите пожалуйста как грамотно составить памятку по проекту.

Такая ситуация, допустим есть один тестировщик и много-много проектов. Бывает что может вернуться на старый проект спустя пару месяцев и больше... На проектах есть толь ТЗ и иногда очень большие)

Решил составить документик где описать краткое содержание проекта, его цель, варианты использования, роли и т.д.

Но хочется сделать хорошо, поэтому к сожалению получается дублирую ТЗ(

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

 

Пока набросал вот так:

 

1. Цель проекта
<Описание цели проекта>
 
2. Функциональные возможности веб-приложения
<Краткое описание функционала веб-приложения. Ответить на такие вопросы как: Из каких частей состоит? Для чего они? Что можно сделать? Их зависимости....>
 
3. Особенности ролей пользователей
<Краткое описание ролей пользователей. Ответить на такие вопросы как: Какие роли могут быть на проекте? Их права, обязанности,...>
 
4. Варианты использования
<Краткое описание вариантов использования. Составить список основных сценариев использования приложения всеми ролями пользователей>
 
5. Зависимости проекта с другими системами
<Краткое описание сервисов с которыми работает проект. Ответить на вопросы: Как будет использоваться? Специфика, интеграции,...>

  • 0

#2 Spock

Spock

    Профессионал

  • Members
  • PipPipPipPipPipPip
  • 1 772 сообщений
  • ФИО:Роман

Отправлено 17 января 2019 - 12:46

не поможет

 

будет быстро устаревать и постоянно отставать от реализации, много ресурсов на поддержание

 

и в результате будет в принципе то же самое что и техническая документация

 

делайте просто для себя разные записки в вики, создайте личную страничку для каждого проекта


  • 1

#3 selen

selen

    Активный участник

  • Members
  • PipPip
  • 102 сообщений
  • ФИО:Сергей

Отправлено 17 января 2019 - 12:53

не поможет

 

будет быстро устаревать и постоянно отставать от реализации, много ресурсов на поддержание

 

и в результате будет в принципе то же самое что и техническая документация

 

делайте просто для себя разные записки в вики, создайте личную страничку для каждого проекта

 

Спасибо за решение.. Согласен с Вами.


  • 0

#4 Little_CJIOH

Little_CJIOH

    Профессионал

  • Members
  • PipPipPipPipPipPip
  • 1 515 сообщений
  • ФИО:Власкин Павел
  • Город:Санкт-Петербург


Отправлено 17 января 2019 - 14:01

Вы хотите очень правильную вещь, но этот документ должен быть частью ТЗ и мэинтейнится аналитиком.
Попытка содержать своё отдельное описание будет приводить к тому, что оно постоянно будет расходится с действительностью, как и сказал Спок.


  • 2

#5 astenix

astenix

    Специалист

  • Members
  • PipPipPipPipPip
  • 906 сообщений
  • ФИО:Лёша Лупан
  • Город:Кишинев


Отправлено 17 января 2019 - 14:15

Попробуйте кратко объяснить проект любому уличному бомжу.

 

Начнете в стиле "Мужик, смотри, это нужно для того, чтобы...", и осознаете, что нужно контекст объяснять, а не реализацию, и перейдёте на "Чтобы выполнить такую-то задачу, мы используем такую-то шняжку..."

 

Потом в документах будете всегда писать грамотно и сразу всем всё будет понятно.

 

Бомжу опосля не забудьте проставиться, он ждёт.


  • 1

Software Testing Glossary - простыми словами о непростых словах.


#6 selen

selen

    Активный участник

  • Members
  • PipPip
  • 102 сообщений
  • ФИО:Сергей

Отправлено 18 января 2019 - 07:16

Всем большое спасибо за советы. Очень доходчиво донесли.


  • 0

#7 astenix

astenix

    Специалист

  • Members
  • PipPipPipPipPip
  • 906 сообщений
  • ФИО:Лёша Лупан
  • Город:Кишинев


Отправлено 18 января 2019 - 13:46

Источник

 

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


  • 0

Software Testing Glossary - простыми словами о непростых словах.



Количество пользователей, читающих эту тему: 0

0 пользователей, 0 гостей, 0 анонимных