Однозначность в требованиях: почему это важно?
Сегодня про одну из самых критичных тем в нашей работе — однозначность в требованиях. Именно этот критерий вам поможет избежать кучу проблем в будущем.
➖➖➖
Я начал копать эту спеку и обнаружил интересный факт: в ней данные противоречили друг другу.
Например, в таблице выходного ответа была написано, что нужно передавать тип документа, а в примере был указан отдельный объект russianPassport и в итоге разработка взяла данные из примера.
Или еще ранее писал пост про то, что в Number в примере указывают 0, а по факту надо передавать число с плавающей точкой.
В этих двух ситуациях знаменатель один - страдает однозначность и разрабы могут интерпретировать прочитанное по-своему, а результатом будут переделки, баги и потеря времени и денег.
➖➖➖
Как этого избежать?
1 У вас должен быть «Единый источник правды».
Не должно быть такого, что в таблице у вас указано одно, в примере другое, в задаче на постановку - третье. Все данные должны быть согласованы.
+ надо определиться, где главный источник, например, задача или confluence.
Лично я, все веду в confluence и мои разработчики знают, что надо смотреть именно в ссылку указанную в задаче.
➖➖➖
2 Не стесняйтесь и просите проводить ревью вашего документа.
Вы можете долго заниматься задачей, у вас может запылится глаз, вы что-то можете потерять, да или просто скопировали случайно не туда.
Поэтому просите коллег аналитиков, а лучше еще и участников команды делать ревью и писать вам комментарии. Расценивайте это не как критику, а как помощь.
➖➖➖
3 Добавляйте комментарии и пояснения, если они необходимы.
Если вам кажется, что разработчик может не понять фразу, то вам не кажется.
Лучше добавить комментарий, который однозначно поможет разобраться. Воспринимайте это будто вы даете пояснения словам, как в словаре, ведь развернутое пояснение иногда очень сильно помогает.
➖➖➖
Что еще может помочь в вопросе однозначности?
Использование шаблонов проектирования API или шаблон требований.
✔ Когда у вас единая структура документа, то так сложнее что-то упустить.
✔ Когда мы пишем спеку по шаблону, то у нас сразу указаны пункты, которые надо обязательно оформить и поэтому мы точно не забудем указать пример.
Создать в правильном формате таблицы, и добавить в нужные места комментарии и ссылки.
Кстати, на курсе по интеграциям и проектированию API, я как раз даю шаблоны, используя которые можно вы можете улучшить качество вашей работы.
➖➖➖
образовательная лицензия
No Л035-01298-77/01352304 от 16.08.2024