Как написать хорошую техническую документацию: советы и примеры

7-12-2018, 16:11
154
0
Как создать белый документ для ICO: правила, советы и примеры в нашем новом материале.
ICO продолжает привлекать внимание сотен проектов по всему миру, которые пытаются привлечь средства с использованием этой технологии. На рынке уже установлены собственные руководящие принципы ICO, и одна из них заключается в том, что проектная группа должна представить свое описание в специальном документе под названием «белая бумага».
Теперь мы поговорим о том, как это должно быть написано.

Что такое документ?
Белая бумага - это документ, в котором объясняется технология blockchain. Этот файл обычно содержит подробное описание архитектуры системы, а также ее взаимодействие с пользователями, информацию о текущей ситуации на рынке и прогнозы роста, условия для выпуска и использования токенов, а также список членов команды, инвесторов и проекта консультанты.
Без правильно спроектированной белой бумаги проекту будет сложно провести успешный ICO: мало кто будет готов инвестировать в отсутствие технически грамотных описаний технологии, а также без какого-либо предыдущего опыта членов команды. Ниже приведены советы о том, как создать высококачественную белую бумагу и некоторые реальные примеры хороших документов.

Как должен выглядеть этот документ?
 Эндрю Чапин, эксперт по блоччанам и основатель проектов Benja.co и Ship Ninja, описал идеальную белую бумагу в колонке HackerNoon. Это очень компетентные советы, которые мы кратко изложим в наших материалах.
Итак, хорошая белая бумага должна иметь следующие разделы:

  • проблема
  • предлагаемое решение и описание продукта
  • описание коммерциализации маркеров (взаимодействие продукта с экономикой и технические условия коммерциализации)
  • команда
  • проблемы и перспективы токенов
Однако, несмотря на то, что информация о команде проекта обычно помещается в конце документа, это один из самых важных элементов. 
По словам Чапина, любой ангел-инвестор может рассказать истории о том, что он инвестирует в сильную команду с плохой идеей, потому что он был убежден в своей способности придумать что-то ценное в процессе деятельности. Например, перед своим стержнем Android раньше была операционной системой камеры, в то время как Nokia ранее занималась деревообработкой и бумажной продукцией, а Pinterest в начале своего пути использовалась как приложение для покупок, и это была не социальная сеть (хотя он недавно вернулся к своим источникам электронной коммерции).
Поэтому важно, чтобы команда была мультипрофессиональной, в том числе людьми, которые уже достигли определенного успеха в прошлом, а также было бы идеально, если бы они имели хотя бы некоторый опыт в блочной цепочке.
Довольно часто команды пытаются начать сбор средств, когда у них нет инженеров, имеющих опыт работы в блокчейне: основатели считают мобилизацию как главное и что они могут нанять инженера позже. Но вы должны посмотреть, прежде чем прыгать, потому что, пока инвесторы не захотят дать деньги проекту, им нужно понять, может ли команда в целом создать то, что было запланировано.
Второй важный раздел «Белой книги» должен содержать описание продукта: данные прототипа, первые пользователи и стратегия развития. Очень часто в ходе ICO команда может иметь только красиво оформленный pdf-файл и несколько макетов, но ни сам продукт, ни пользователи, ни стратегия не идеальны. Если в проекте уже есть существующая экосистема и пользователи, это увеличивает шансы на успешную выработку токена, а это означает, что доступность этих элементов должна быть представлена в документации.
Также очень важен подробный план использования привлеченных средств. Сегодня в мире ICO есть много организаций, которые сообщают о своих планах создания «промышленных консорциумов», некоммерческих подразделений или запускают ряд событий для «развития отрасли». Это может вызвать подозрение, что член команды имеет намерение потратить немного денег не на разработку продукта, а на что-то другое (возможно, на личные нужды).
Информация о токене должна быть детализирована во время предложения на бирже. Если ответа на этот вопрос нет или, согласно плану, это должно произойти через 30-60 дней, есть основания подозревать, что что-то не так, как ожидалось. По словам Чапина, в этом случае очень вероятно, что проектная команда собирается манипулировать ценой токена в момент открытия свободной торговли. В целом, общественность заинтересована в будущем взаимодействии компании с выпущенными токенами: будет ли вопрос ограниченным до предпродажной подготовки, что определяет начало продаж на рынке и будут ли выкупные платежи проводиться.
Технический документ должен содержать подробное техническое описание проекта и планы его дальнейшего развития (план развития). Теоретически команда должна представить подробный рабочий план на следующие 12-18 месяцев, который должен включать бета-запуск. Если какой-либо из пунктов дорожной карты уже выполнен, это означает преимущество для команды.
Идеальная белая книга: 3 примера успешных проектов
 
Давайте воплотим эту теорию на практике: самый простой способ понять требования к идеальному документу ICO - увидеть реальные примеры успешных проектов. Мы выбрали три очень успешных проекта и проанализировали их технический документ (больше примеров можно найти по этой ссылке).
«Monetha» - это проект платежной системы для блокчейн, который собрал 37 миллионов долларов (95 000 ETH) всего за 18 минут. В белой бумаге их системы содержатся все разделы, упомянутые выше. Он содержит подробное описание рабочего плана проекта, символической экономики, планов использования фондов, а также записей о работе членов команды - даже предыдущего опыта работы с инвестициями.
В дополнение к техническому описанию архитектуры продукта, есть также несколько простых для лучшего понимания схем.
Другим примером является проект «Aeternity», который собрал около 34 миллионов долларов. Его технический документ показывает, что документация не обязательно должна быть полной. Файл не имеет красивого дизайна и создается в формате исследовательской статьи (двухстоечное, простое форматирование).
Формат исследования действительно заслуживает доверия, в то время как документ не должен быть таким длинным (~ 10 страниц).
И, наконец, победителем проекта, который привлек 257 миллионов долларов во время ICO, является «Filecoin». Его основатели также решили использовать стиль исследования для белой бумаги без каких-либо дизайнерских усовершенствований.
 
Стиль презентации соответствует шаблону: множество формул и разные схемы. 

Последние мысли

За последние месяцы мы активно изучали рынок ICO; нас также интересует дизайн контента, который выбирают при запуске блочной цепи. И в конце статьи мы дадим несколько рекомендаций по результатам, основанным на этих наблюдениях:
  • Хорошая белая бумага не спасет плохой проект : если команда пытается решить несуществующую или не очень важную проблему, или если ее члены не имеют большого опыта разработки, они новы для блокировки, то это что проект не будет успешным, даже при создании надлежащей документации, и это должно быть то, что нужно знать.
  • Модель должна быть подходящей для команды : стиль исследовательской статьи, выбранный проектами «Filecoin» и «Aeternity», отличается от более популярного проекта, выбранного «Монетой». В частности, в «исследовательской статье» обычно нет раздела с описанием команды - для этой цели есть только раздел на своем веб-сайте. Чтобы создать высококачественный исследовательский документ, автор должен иметь опыт написания таких документов. Отсутствие опыта означает лучше следовать «Монете» и сделать уникальную презентацию проекта.
  • Важно учитывать общественность: на стиль и формат белой бумаги влияет тот, кто ее прочтет. Если целью является привлечение технически грамотной аудитории и ученых, тогда логично представить информацию в их обычной форме. Но если целью является привлечение более широкой аудитории, то вы не должны слишком усложнять документ, вы даже можете создать две версии: легкий и более технический - для тех, кто хочет получить более подробную информацию.
Опубликовал melkij
Похожие публикации
Центральный банк Израиля ищет общественный вклад в инициативу крипторегулирования
Центральный банк Израиля и различные другие правительственные учреждения ищут информацию от общественности относительно регулирования виртуальных активов. Согласно заявлению, опубликованному Банком Израиля, необходимо отслеживать изменения в области цифровых активов и понимать их влияние на финансовую стабильность, экономическую активность и на финансовые рынки.
M2O - ICO
Все пробег и баллы, это будет один в M2O. M2O будет интегрировать существующие пробеги и точечные рынки и создает глобальные сервисы членства через Blockchain.
Продвижение рекламного контента ICO: 3 полезных совета.
Первоначальное предложение монет или ICO - это инструмент для привлечения инвестиций, который все чаще применяется стартапами.
Самсон Моу, Blockstream: Хватит воспринимать white paper биткоина как библию
Прошло десять лет со дня публикации white paper биткоина. Десять лет, чтобы осмыслить значение биткоина. У нас было десять лет разработки, чтобы улучшить удобство использования криптовалюты и масштабировать её. Тем не менее, несмотря на приличный срок, всё ещё существуют фанатики, которые пытаются интерпретировать white paper.
Комментарии
Добавить комментарий
Добавить свой комментарий:
Ваше Имя:
Ваш E-Mail:
Это код:
Кликните на изображение чтобы обновить код, если он неразборчив
Введите сюда:
Опрос
Оцените работу движка