Пост-камингаут. Вдруг, тоже кому-нибудь глаза откроет, как мне. Я всегда считал, что спецификация — это такое детальное техзадание. Типа спроектировал штуку, описал как что работает, передал разработчику, и пошёл читать книжку. Покажи, как будет готово, в общем.
Книжку, правда, почитать ни разу не получилось: разработчики всё равно спрашивают как что работает, или просто делают по-своему (не так, как задумано).
Одно время я подбешивался: чё ты не читаешь док, для тебя же писал. А недавно, когда делали Hourly с Женей Ртищевым, до меня наконец-то дошло: я всё это писал только для себя.
Документация моя выглядит обычно вот так:
Работает это так по моим наблюдениям. Как только разработчик берётся за проект, он смотрит макеты в Цеплине, ему всё более-менее понятно, тонких вопросов пока не возникает, потому что смотрит с высоты. Он начинает накидывать основу, всё хорошо. А потом начинают возникать моменты, которые по макетам уже не поймёшь. Вот он и задаёт вопросы мне.
Почему разработчик при этом не читает док? Ну, потому что, во-первых, док часто большой, и читать лень, ведь хочется работать, а не копаться в буквах. Особенно, когда большую часть уже и так сделал. Во-вторых, надо искать в этом доке ответ на свой вопрос. Это ещё одно препятствие. Написать в чат проще. Ну, как с инструкциями от техники: основу мы знаем, а если что-то непонятно, то проще спросить у того, кто рядом, а не читать книжку.
И что, теперь не писать спецификации? Конечно, писать. Потому что всё запомнить невозможно. Когда меня о чём-то спрашивают, я сам часто иду в док, ищу ответ, надеясь, что он там есть. Потому что времени прошло между написанием ответа и вопросом достаточно, чтобы забыть многие детали. А ещё пока всё описывается, возникает для самого себя много вопросов типа «а вот это как тогда работает?», или «а если сюда тогда нажать?». Спецификация (как и прототипы) делает проект понятнее и реализуемее.
Главное — перестать относиться к спецификации как к техническому заданию, а относиться как к базе знаний по проекту. Не «вот док. покажи, как закончишь», а «вот тут я для себя описал как что работает, чтобы не забыть. можешь тоже смотреть или спрашивать меня, я подскажу». И, конечно, спецификации не в граните отлиты: по ходу работы их надо обновлять и дополнять.
Было бы интересно почитать чужие истории про документации. Как с ними складывается работа в ваших проектах?
Источник: сайт designpub.ru
Загрузка...
