Как написать документацию для приложения?

Помогите расставить все по полочкам, что такое fspec, uses case, uses story, что из себя предстовляет вообще документация для приложения, это имеет отношение к unit test`ам.

Есть тестовое приложение To Do List на ноде и нужно написать документацию для него. Но непредстовляю как.

Можете скинуть материалы или пример проекта на гитхабе..
Заранее Спасибо.
  • Вопрос задан
  • 640 просмотров
Решения вопроса 2
lxsmkv
@lxsmkv
Test automation developer
User story описывает цели которые могут быть достигнуты с помощью приложения. Они определяют пользу. Например, чтобы решить какую задачу выполнить сегодня, пользователь хочет определить самые приоритетные задачи. Польза приложения тут в помощи принятию решений по задачам. Тут нужно думать максимально с т.з конечного пользователя. Зачем он что-то делает и как продукт может помочь ему в этом.

Use cases будут включать в себя описания какие взаимодействия с приложением пользователь может произвести чтобы достичь своей цели. Например: Отсортировать по приоритету. Отфильтровать по тегам. И пр. По юзкейсам можно проверить, что приложение действительно предоставляет заявленные функции заявленным образом.

По юзкейсам можно проводить системное тестирование. Т.е. есть заявленный сценарий, работает он или нет.

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

По функциональной спецификации пишется реализация, и сам код приложения уже покрывается юнит-тестами.
Ответ написан
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
Тут все подробно и по полочкам. Как в универе: sce2.umkc.edu/BIT/burrise/pl
Ответ написан
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы