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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Техническая документация на сервис, Нужна помощь
 
Здравствуйте. Так уж получилось, что меня попросили составить техническую документацию, а я в этом вообще практически не разбираюсь, но уже достаточно много прочла и ознакомилась с информацией по данной теме.
Мне дали несколько тестовых файлов: smoke-test, limit и basic (файлы в разрешении features). Вроде бы все просто, но никак не могу понять, как писать эту документацию, не могли бы вы мне помочь хотя бы сделать набросок по этой документации, это очень сильно мне поможет.  
 
Для начала определите какую документацию вам нужно написать и для кого. Я вот этого не понял из вашего сообщения)
 
Цитата
writer написал:
Для начала определите  какую  документацию вам нужно написать и  для кого . Я вот этого не понял из вашего сообщения)
Документацию надо написать на сервис resm, где за основу взяты написанные приемочные тесты.Resm-сервис, который выделяет ресурсы по требованию
Пользователи сервиса - технические специалисты, которые:
1. Понимают основные принципы работы операционных систем семейства *nix:
CentOS, Ubuntu, MacOS etc.
2. Имеют представление о HTTP, REST, JSON

Дополнительные требования
1. Быстрое погружение для пользователей, которым интересно сразу же
попробовать систему в работе, не вникая во все подробности
2. Наличие полной спецификации системы в максимально сжатом виде
3. Предположительные инструкции по установке и настройке, ответы на часто
задаваемые вопросы

Ниже представлены сами тесты на человеко-читаемом языке:

Код
basic feature
# vim: set tabstop=2
shiftwidth=2 softtabstop=2 et:

Feature: allocate and deallocate resources
  Users can ask the service to allocate a resource, or deallocate it if it is
  not needed anymore.
  Resources are allocated by the user name and deallocated by the resource name.
  User can request the list of all the allocated and deallocated resources,
  or just the list of allocated resources by him only.
  The service provides an ability to reset its state so that all the resources
  become deallocated.
 
  Example:
  $ curl http://resm.tld/reset
  $ curl http://resm.tld/allocate/bob
  resource#1
  $ curl http://resm.tld/list
  {"allocated":{"resource#1":"bob"},"deallocated":[...]}
  $ curl http://resm.tld/list/bob
  ["resource#1"]
 
Scenario: list resources before allocation
  Given an empty pool
  When a user "alice" lists resources
  Then status code should be 200
  And the resources list should be empty
 
Scenario: list all resources before allocation
  Given an empty pool
  When a user lists all resources
  Then status code should be 200
  And the allocated resources list should be empty
 
Scenario: deallocate resource before allocation
  Given an empty pool
  When a user deallocates resource "resource"
  Then status code should be 404
  And an error message should be "Not allocated"
 
Scenario: allocate resource
  Given an empty pool
  When a user "alice" allocates resource
  Then status code should be 201
  And the response should be not empty
 
Scenario: list resources after allocation
  Given an empty pool
  When a user "alice" allocates resource "a"
  And a user "alice" lists resources
  Then status code should be 200
  And the resources list should be
    | resource |
    | %a%      |
 
Scenario: list all resources after allocation
  Given an empty pool
  When a user "alice" allocates resource "a"
  And a user lists all resources
  Then status code should be 200
  And the allocated resources list should be
    | user  | resource |
    | alice | %a%      |
 
Scenario: deallocate resource after allocation
  Given an empty pool
  When a user "alice" allocates resource "a"
  And a user deallocates resource "%a%"
  Then status code should be 204
  And the response should be empty
 
Scenario: duplicate allocate resource
  Given an empty pool
  When a user "alice" allocates resource
  And a user "alice" allocates resource
  Then status code should be 201
  And the response should be not empty
 
Scenario: list resources after duplicate allocation
  Given an empty pool
  When a user "alice" allocates resource "a"
  And a user "alice" allocates resource "b"
  And a user "alice" lists resources
  Then status code should be 200
  And the resources list should be
    | resource |
    | %a%      |
    | %b%      |
 
Scenario: list resources after deallocation
  Given an empty pool
  When a user "alice" allocates resource "a"
  And a user deallocates resource "%a%"
  And a user "alice" lists resources
  Then status code should be 200
  And the resources list should be empty
 
Scenario: duplicate deallocate resource after allocation
  Given an empty pool
  When a user "alice" allocates resource "a"
  And a user deallocates resource "%a%"
  And a user deallocates resource "%a%"
  Then status code should be 404
  And an error message should be "Not allocated"
 
Scenario: allocate resource after deallocation
  Given an empty pool
  When a user "alice" allocates resource "a"
  And a user deallocates resource "%a%"
  And a user "alice" allocates resource
  Then status code should be 201
  And the response should be not empty
 
Scenario: list only own resources
  Given an empty pool
  When a user "alice" allocates resource "a"
  And a user "bob" allocates resource "b"
  And a user "alice" allocates resource "c"
  And a user "alice" lists resources
  Then status code should be 200
  And the resources list should be
    | resource |
    | %a%      |
    | %c%      |
 
Scenario: list all resources for several users
  Given an empty pool
  When a user "alice" allocates resource "a"
  And a user "bob" allocates resource "b"
  And a user "alice" allocates resource "c"
  And a user lists all resources
  Then status code should be 200
  And the allocated resources list should be
    | user  | resource |
    | alice | %a%      |
    | bob   | %b%      |

    | alice | %c%      | 

limit.feature

Код
# vim: set tabstop=2 shiftwidth=2 softtabstop=2 et:
Feature: limit the total count of resources
  Resources number (capacity) is limited. If all the resources were allocated,
  the server rejects the user's request until some other (or the same) user
  deallocates a resource.
 
  Example:
  $ curl http://resm.tld/allocate/alice
  Out of resources.
 
Scenario: reach allocation limit
  Given an empty pool
  When a user "alice" allocates resource
  When a user "alice" allocates resource
  When a user "alice" allocates resource
  When a user "alice" allocates resource
  When a user "alice" allocates resource
  When a user "alice" allocates resource
  Then status code should be 503
                                        And an error message should be "Out of resources"

smoke-test.features
Код
# vim: set tabstop=2
shiftwidth=2 softtabstop=2 et:

Feature: check that the environment is set up correctly
 
Scenario: smoke test
  When we check that the environment is set up properly

  Then a service should be accessible
 
Насколько я понимаю, это тестовое задание, возможно фирмы MachineZone.
Сделано формально, по аналогии с тестовым заданием для программистов http://machinezone.ru/challenges/resource-manager.
Страницы: 1
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить картинки
Отправить Отменить