:: urbansheep (urbansheep) wrote,
:: urbansheep
urbansheep

Правда о документации: хорошие описания проектов универсальны

Документация — это обычно то, о чём разработчикам думать лень, а всем остальным непонятно, как к этому подступиться. Пока я работал продакт-менеджером, мне довелось научиться писать короткие и довольно удобные документы под названием «описание проекта» — нечто вроде концепции, на несколько страниц всего. Но там сразу и с целями и задачами ясность, и краткое описание интерфейсов и общего потока, и краткое содержание следующих серий.

В общем, штука приятная и удобная (хотя вот samorodkin, beskov или hemule, как люди, которым потом из таких документов приходится собирать реальные техзадания, наверняка могут спеть не одну песню о том, как это ужасно, и что в описании проекта многое непонятно). Но я сейчас немного о другом. Как только приучаешься писать такие описания, то автоматически решается много других задач, связанных с общением о продукте, который ты разрабатываешь.

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

Так как в описании у тебя уже есть разные блоки (про маркетинговые показатели, про пользовательские действия, про тонкости реализации и интерфейс), то у тебя есть заготовки для того, чтобы говорить с каждым из тех, кому потом нужно будет реализовывать то, что ты тут понаписал — и с дизайнерами, и с разработчиками, и с маркетингом. И к этим разговорам ты готовишься заранее, в процессе подготовки этой вот простой штуки из нескольких листков.

Во-вторых, из этого же описания очень легко сделать потом материал для печати: план для анонса — хоть для блога, хоть для пресс-релиза, хоть для презентации. То есть, в нескольких случаях, когда мне пришлось для маркетинга готовить текст постов или релизов, а своего я толком ничего придумать не мог, достаточно было немного подрихтовать и отколеровать ключевые позиции из описания проекта. Сильно экономит время и нервные клетки, особенно когда анонсировать нужно «чужой» проект, который ты и знаешь хуже, и любишь меньше.

В-третьих (это уже из моей внутренней практики), краткое описание из описания проекта — практически готовая часть для пользовательской документации, достаточно добавить немного подробностей, и описание того, как работает твой сервис, готово. И это всё очень облегчает нашу нелегкую участь людей, которые придумывают то, что потом будут ругать все остальные.

Это я всё к тому, что хорошую документацию иногда не надо писать специально (особенно в небольших проектах). Она сама возникает, для этого только нужна правильная организация процесса и наличие каких-то совсем базовых привычек и навыков по управлению знаниями и их передаче в коллективе.


Subscribe
  • Post a new comment

    Error

    Comments allowed for friends only

    Anonymous comments are disabled in this journal

    default userpic

    Your reply will be screened

    Your IP address will be recorded 

  • 10 comments